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, icons, and a service worker. Nothing else to install.

  •   Zero Configuration

    Start with a working site in seconds. 8 core plugins and 36 Markdown extensions load automatically; social cards are opt-in. 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 calls for readers, no extra_javascript, no configuration.

  •   Syntax Highlighting

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

  •   TikZ Diagrams

    Write TikZ diagrams as .tex files. Automatically compiled to SVG at build time (requires a LaTeX toolchain; skipped gracefully when unavailable).

  •   Blogging

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

  •   Offline Support

    Service worker caches all assets. Your documentation works without an internet connection.

Markdown Extensions

All enabled by default. No configuration needed.

CategoryExtensions
Structuretoc, tables, fenced_code, def_list, footnotes, md_in_html, meta
Textadmonition, abbr, attr_list, nl2br, sane_lists, wikilinks
pymdownxarithmatex, b64, 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

8 core plugins auto-load — no plugins: config needed. Social cards are opt-in (plugins: [social]).

PluginWhat it does
blogBlogging with authors, categories, archives, pagination, RSS
i18nMulti-language sites (suffix-mode locale variants)
infoAdmonition callouts (note, tip, warning, danger)
metaOpenGraph metadata
minifyCompress HTML/CSS/JS output
privacySelf-host external assets (Google Fonts, CDN scripts)
searchFull-text search with Lunr.js
tagsTag system with tag pages

PWA / Offline

Every built site includes a service worker that:

  • Caches HTML pages — network-first, updates cache in background
  • Caches assets — CSS, JS, fonts, images served from cache for speed
  • Versioned updates — Each build generates a unique SW hash, forcing browser refresh
  • Auto cleanup — Old caches purged when new version activates

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