Skip to content
capjanPublic

About

Plain Markdown in, fast static docs out. One self-contained tool with linter, static diagrams, search, and PDF export.

Topics

Resources

Contributing

Stars

5 stars

Watchers

1 watching

Forks

Repository files navigation

MDU – Plain Markdown, beautifully published.

Build NuGet Docker Pulls License: MIT

Documentation  ·  Get started  ·  Features  ·  Commands  ·  Releases


Turn a folder of plain Markdown into a fast, searchable documentation site.
One CLI tool. Sensible defaults. Easy configuration.

MDU documentation in light and dark themes
The MDU documentation, rendered by MDU itself.


Quick start

dotnet tool install -g mdu   # install
mdu new .                    # create a starter docs project
mdu serve                    # live preview of ./docs
mdu render                   # build the site into ./site

Prefer a standalone executable or Docker? See the installation guide.

Why MDU

  • Install it your way. As a standalone executable, a .NET tool, or a Docker image.
  • Everything included. Theme, navigation, search, and icons work out of the box, with no plugins to choose.
  • Portable Markdown. Callouts use the GitHub syntax and diagrams are code blocks, so your files stay readable on GitHub, GitLab, or in any editor.
  • Checked in CI. mdu lint finds broken links, wrong link casing, and unknown tags before you publish.
  • Diagrams without JavaScript. Mermaid flowcharts, sequence and state diagrams, and PlantUML component diagrams become static SVG with light and dark themes.
  • PDF included. mdu pdf exports the whole site as one document.
  • Coming from Material for MkDocs? The icon shortcodes work as they are, and mdu fix converts admonitions, tabs, and card grids.

See how MDU compares with Material for MkDocs, Docusaurus, Starlight, and DocFX.

Explore the documentation

Setup →
Install MDU as a .NET tool, standalone executable, or Docker image.
Commands →
Preview, lint, render, and export your docs to PDF.
Features →
Callouts, diagrams, OpenAPI, math, icons, and code highlighting.
Navigation →
Tabs, sidebar, and breadcrumbs built from your folder structure.
Publish →
Host the site on GitHub Pages, GitLab Pages, or any web server.
Architecture →
How MDU parses, validates, and renders your documentation.

Released under the MIT License.

About

Plain Markdown in, fast static docs out. One self-contained tool with linter, static diagrams, search, and PDF export.

Topics

Resources

Contributing

Stars

5 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages