Getting started

DocsForge is a self-contained documentation engine. pip install, write Markdown, build.

Installation

pip install docsforge

Requires Python 3.10+.

# Create a new project interactively
docsforge
cd my-docs

# Start the dev server
docsforge serve

# Build for production
docsforge build

After running docsforge to create a project, your directory looks like this:

my-docs/
├── docsforge.yml    # Site configuration
├── docs/
│   └── index.md     # Homepage
└── site/            # Build output

The smallest valid docsforge.yml:

site_name: My Project

That's it. All plugins, extensions, and theme settings use sensible defaults. Add configuration only when you need to customize.

Feature	Default
Theme	Material (built-in)
Plugins	search, tags, blog, info, meta, minify, privacy, i18n
Markdown extensions	36 total — all pymdownx + python-markdown (+ 3 built-ins: toc, tables, fenced_code)
Math	KaTeX (vendored, `$$...$$` works)
Code highlighting	Pygments (colored syntax)
Dark mode	Light/dark toggle in header
Fonts	Self-hosted (privacy plugin downloads Google Fonts)
Diagrams	TikZ support (`.tex` → SVG at build; needs a LaTeX toolchain)
Offline	Service worker caches all assets