Skip to content

Features

DocsForge includes everything you need to write and publish documentation. No extra installs, no extra config.

Core Features

  •   Zero Dependencies

    pip install docsforge gets you the engine, Material theme, all plugins, all Markdown extensions, KaTeX math, Pygments highlighting, fonts, and icons. Nothing else to install.

  •   Zero Configuration

    Start with a working site in seconds. 7 plugins and 31 Markdown extensions load automatically. Customize only what you need.

  •   Light & Dark Mode

    Automatic system preference detection with a manual toggle. Both modes are fully customizable with your brand colors.

  •   Full-Text Search

    Client-side search powered by Lunr.js. No external services, no backend required. Works offline.

  •   Math Rendering

    Write $$...$$ and it renders with KaTeX. No CDN, no extra_javascript, no configuration.

  •   Syntax Highlighting

    Code blocks render with Pygments colors at build time. Supports all major languages.

Markdown Extensions

All enabled by default. No configuration needed.

Category Extensions
Structure toc, tables, fenced_code, def_list, footnotes, md_in_html, meta
Text admonition, abbr, attr_list, nl2br, sane_lists, wikilinks
pymdownx arithmatex, betterem, caret, critic, details, emoji, escapeall, extra, fancylists, highlight, inlinehilite, keys, magiclink, mark, pathconverter, progressbar, quotes, saneheaders, smartsymbols, snippets, striphtml, superfences, tabbed, tasklist, tilde

Plugins

All enabled by default. No plugins: config needed.

Plugin What it does
blog Blogging with authors, categories, archives
info Admonition callouts (note, tip, warning, danger)
meta OpenGraph metadata
minify Compress HTML/CSS/JS output
privacy Self-host external assets (Google Fonts, CDN scripts)
search Full-text search with Lunr.js
tags Tag system with tag pages

Publishing

DocsForge builds static HTML. Deploy site/ anywhere:

  • GitHub Pages — Ready-to-use workflow
  • Netlify, Vercel — Drag and drop
  • Your own server — rsync site/ server:/var/www/docs