Skip to content

DocsForge

DocsForge

Write your documentation in Markdown. Build a professional static site in seconds. Deploy anywhere.

Coming from MkDocs + Material?

DocsForge is a candidate drop-in replacement for MkDocs + Material for
MkDocs — same Markdown, same theme: block, same look and feel.

If migration breaks anything, we fix it for free. Run the
migration script; if your site
doesn't build, or renders differently than it did before, send us your
config and we'll fix it until it does — at no cost.

Open an issue or email
qingquanshi65@gmail.com with [MIGRATION] in the subject. Email is
fine if your docs are private and you'd rather not post the config.

pip install docsforge
docsforge serve

What makes DocsForge different

  •   Zero Dependencies

    Everything is bundled. pip install docsforge gets you the engine, Material theme, all plugins, all extensions, fonts, icons, math rendering, and a service worker.

  •   Zero Config

    Start with just site_name:. All 6 core plugins and 36 Markdown extensions load automatically; blog, social cards and privacy are opt-in. Customize only when you need to.

  •   Math Works

    Write $$...$$ and it renders. KaTeX is vendored — no CDN calls in the browser, no extra_javascript, no setup.

  •   Syntax Highlighted

    Code blocks render with Pygments colors at build time. No client-side JavaScript needed.

  •   Instant Search

    Full-text search built in, powered by a client-side Marz index.

  •   Dark Mode

    Light/dark toggle in the header. Auto-detects system preference.

  •   TikZ Diagrams

    Write TikZ diagrams as .tex files. Auto-compiled to SVG at build time (requires a LaTeX toolchain).

  •   Blogging

    Built-in blog with authors, tags, archives, pagination, and RSS feeds.

  •   Offline Support

    Service worker caches all assets. Works without an internet connection.

Quick start

pip install docsforge
docsforge          # create a new project interactively
cd my-docs
docsforge serve

That's it. Your documentation site is now running at localhost:8000.

What you get

FeatureStatus
Admonitions (!!! note) Zero config
Math ($$...$$) Zero config
Code highlighting Zero config
Tables Zero config
Task lists (- [x]) Zero config
Footnotes ([^1]) Zero config
Definition lists Zero config
Abbreviations Zero config
Content tabs Zero config
Diagrams (Mermaid, TikZ) Zero config
Emojis Zero config
Blog Zero config
Tags Zero config
Search Zero config
Privacy (self-host assets) Zero config
Minify (HTML/CSS/JS) Zero config
Offline/PWA Zero config

Next steps

  •   Getting Started

    Installation, first steps, and basic configuration

  •   Setup Guides

    Customize colors, fonts, navigation, search, and more

  •   Reference

    Markdown syntax, components, and formatting options

  •   Blogging

    Set up a blog with authors, tags, and RSS feeds