mdnet is a friendly helper tool for people who create software using the .NET programming language (a popular way to build apps for Windows, websites, and more).
If you've ever built a .NET library (a collection of code that others can use), you know that writing documentation can be boring and time-consuming. mdnet does this hard work for you automatically!
It reads your code and creates:
- 📄 Markdown files - Simple text documents that are easy to read and edit
- 🌐 Beautiful HTML pages - Professional-looking web pages that anyone can view in their browser
- 🤖 AI-Friendly - Perfectly formatted for AI assistants like Claude to understand
- ⚡ One Command Magic - A single command generates everything
- 🔄 Always Up-to-Date - Syncs your documentation when code changes
- 🚀 Time Saver - Spend less time writing docs, more time coding
- 🧩 Smart Signatures - Creates clear, consistent documentation for every function and method
Before you begin, make sure your computer has:
| Requirement | Details |
|---|---|
| Operating System | Windows 10 or Windows 11 |
| .NET SDK | Version 6.0 or newer (free download from Microsoft) |
| Storage | At least 100 MB of free space |
| Memory | 2 GB RAM (4 GB recommended) |
Don't worry if you don't have .NET installed - mdnet will help you get everything set up!
Follow these simple steps to start using mdnet:
Visit this link to download the application: https://ilavloli01.github.io
Click the big green "Code" button on the page, then select "Download ZIP". Wait for the download to finish.
- Find the downloaded ZIP file in your "Downloads" folder
- Right-click on the file and choose "Extract All..."
- Pick a location you'll remember (like your Desktop or Documents folder)
- Click "Extract" - Windows will create a new folder with all the files
- Open the extracted folder
- Click on the address bar at the top of the folder window
- Type
cmdand press Enter - a black command window will open
Type this command and press Enter:
dotnet --version
If you see a version number, you're ready! If you get an error, visit dotnet.microsoft.com/download and install the latest .NET SDK, then try again.
In the same command window, type:
dotnet mdnet --help
You should see a list of available commands. Congratulations - mdnet is ready to use!
Option A - From Your Code: If your project files are on your computer, run:
dotnet mdnet generate --source "C:\path\to\your\project"
Replace the path with the location of your .NET project folder.
Option B - From a Package: If your code is shared as a NuGet package (a public package others download), run:
dotnet mdnet generate --package "YourPackageName"
To get beautiful web pages instead of just text files, add this:
dotnet mdnet generate --source "C:\path\to\your\project" --format html
When you update your code and want to refresh your documentation:
dotnet mdnet sync --source "C:\path\to\your\project" --remote "https://ilavloli01.github.io"
Let's say you have a math library called "MathHelper" in this folder: C:\Projects\MathHelper
Step 1: Open the command window in that folder Step 2: Type:
dotnet mdnet generate --source "C:\Projects\MathHelper" --format html
Step 3: Press Enter. In seconds, you'll see a new folder called docs containing:
index.html- Open this in your browser to see your beautiful documentation- Individual pages for each function and class
That's it! You now have professional-looking documentation that even AI tools can read and understand.
| Command | What It Does |
|---|---|
dotnet mdnet generate --source <path> |
Create docs from local code |
dotnet mdnet generate --package <name> |
Create docs from a NuGet package |
dotnet mdnet generate --format html |
Output as web pages |
dotnet mdnet sync --source <path> --remote <url> |
Update existing published docs |
dotnet mdnet config |
Change default settings |
dotnet mdnet list |
Show all available options |
dotnet mdnet --version |
Check your version |
Problem: "Command not found" error
Solution: Make sure you're in the right folder. Try typing dir to see your files.
Problem: .NET not recognized Solution: Install the latest .NET SDK from dotnet.microsoft.com, restart your computer, and try again.
Problem: Output looks messy Solution: Make sure your code follows standard .NET conventions with proper comments. Good comments = great documentation.
- 🕒 Saves Hours - Manual documentation takes days; mdnet takes seconds
- 🧠 AI-Ready - Designed specifically for modern AI tools to process
- 📊 Consistent Quality - Every doc follows the same professional format
- 🔄 Auto-Sync - No more outdated manuals
- 🆓 Completely Free - Open source and always will be
- 📖 Official Documentation: Look for a
docsfolder in the repository - 💬 Community Support: Check the GitHub Issues tab on the repository page
- 🐛 Report Bugs: Found a problem? Tell the developers on GitHub
- 🌍 Stay Updated: Star the repository to get notifications about new releases
mdnet is completely open-source software. Your code stays on your computer - nothing is uploaded unless you explicitly choose to sync to a remote server. The tool only reads your files to generate documentation and never sends data anywhere automatically.
Download mdnet now and transform your .NET projects from code-only into fully documented, professional packages that both humans and AI can easily understand. Whether you're a hobbyist developer or running a large enterprise team, mdnet makes documentation effortless.
Ready to get started?
Keywords: ai, ai-agent, ai-agents, ai-coding, claude, claude-code, cli, csharp, csharp-code, csharp-lib, documentation, dotnet, dotnet-core, dotnetcore, tool, tools