🤖 mdnet - AI-Ready Docs for .NET Developers

📘 What is mdnet?

mdnet is a friendly, command-line tool that creates beautiful, AI-friendly documentation for your .NET libraries. It reads your code (from source files or NuGet packages) and automatically generates two things:

• Markdown files – lightweight, readable text files perfect for developers, version control, and AI tools.
• Static HTML pages – polished, web-based documentation that anyone can open in a browser (built with Markdoc).

The docs are "signature-first," meaning they focus on accurate function signatures and API references – exactly what AI coding assistants (like Claude Code) need to understand your code quickly and correctly.

🚀 Getting Started – Your First Steps

Don't worry if you're not a programmer. Just follow these simple steps to get mdnet running on your Windows computer.

Step 1: Download mdnet

Visit this link to download the application:

On the page, look for the green Code button. Click it, then choose Download ZIP. This downloads the whole tool as a ZIP file.

Step 2: Unzip the Folder

1. 1. Find the downloaded ZIP file (usually in your Downloads folder).
2. 2. Right-click it and choose Extract All…
3. 3. Follow the simple prompts to unpack the folder.

You'll now have a new folder called mdnet-main.

Step 3: Open a Terminal

1. 1. Inside the mdnet-main folder, press the Shift key on your keyboard and right-click on an empty area.
2. 2. Choose Open PowerShell window here or Open Command Prompt here.

A black or blue window will appear. This is called a "terminal."

Step 4: Run mdnet

Type this command and press Enter:

You'll see a list of available commands. That's it – you're ready to generate docs!

To generate documentation for a NuGet package, use:

Or for your local source code:

✨ Key Features

• 🤖 AI-First Design – Output is structured to be easily parsed by AI agents, making your codebase friendlier to tools like Claude and Copilot.
• 📝 Dual Output – Get both Markdown and clean HTML, so you can choose how to share your docs.
• 📦 Works with NuGet – You don't even need the source code. Just give it a package name, and it fetches everything it needs.
• 🔄 Auto-Sync – Keep your published docs up-to-date automatically. Every time your code changes, mdnet can refresh the documentation for you.
• ⚡ Fast & Lightweight – Runs as a simple CLI tool, no heavy IDE required.
• 🔍 Signature Accuracy – Focuses on exact method signatures, parameter types, and return types – the details that matter most.
• 🎨 Clean Styling – The generated HTML looks professional right out of the box, with no extra configuration.

💡 Who Should Use mdnet?

• .NET Library Creators – If you've built a C# library, mdnet gives you professional docs in minutes.
• AI Tool Enthusiasts – Want your code to work better with AI assistants? Properly structured docs make a huge difference.
• Teams – Keep internal API docs fresh without manually editing markdown or HTML.
• Open-Source Maintainers – Automate your documentation pipeline and let contributors focus on code.

🛠️ System Requirements

• 🖥️ Windows 10 or 11 (64-bit recommended)
• 📦 .NET SDK 6.0 or later (if you want to build from source – but for using the tool, no additional installation is needed)
• 📶 Internet connection for downloading NuGet packages (optional, only if you use the package feature)
• 🧠 10 minutes of your time to learn the basics

📄 Example Output

Here's a taste of what mdnet generates. For a simple Calculator class, it would produce:

Markdown output:

HTML output:

The same information is rendered as a clean, styled webpage with proper headings, code highlighting, and responsive design – ready to be hosted anywhere.

📖 Getting More Help

Even though mdnet is simple, you might have questions. Here are some friendly tips:

• Run .\mdnet --help in the terminal anytime to see all commands.
• Check the official GitHub repository for updates, tutorials, and community discussions.
• Experiment! Try it on a small test project first to get comfortable.

🔗 Download Again

Need to get mdnet again? No problem – just click the button below:

Visit this link to download the application.