Documentation Made Simple
A minimal static site generator for documentation. Fast, clean, and easy to use.
Features
Markdown-based
Write documentation in plain Markdown with YAML frontmatter. No complex configuration required.
Lightning Fast
Generate complete documentation sites in milliseconds. Built with Go for maximum performance.
Dark Mode
Automatic light and dark themes with localStorage persistence. Easy on the eyes, day or night.
Search
Client-side full-text search with keyboard shortcuts. Find what you need instantly.
OpenAPI Support
Interactive API documentation with endpoint testing, code samples, and schema visualization.
Status Pages
Track service health with incidents, maintenance windows, uptime metrics, and RSS feeds.
Changelog
Version history with RSS feed. Automatically generated from markdown release notes.
Landing Pages
Marketing-style homepages with hero sections, feature grids, and call-to-action blocks.
Portfolio
Showcase projects with filterable tags, images, and individual project pages.
SEO Ready
Sitemap.xml, meta tags, llms.txt for AI assistants, and clean URL support.
Syntax Highlighting
Code blocks with support for 100+ languages via Chroma. Copy button included.
GFM Support
Full GitHub Flavored Markdown including tables, task lists, and admonitions.
Quick Start
Install
Download the binary for your OS/architecture
curl -sSL \
https://github.com/studiowebux/minimaldoc/releases/latest/download/minimaldoc-$(uname -s)-$(uname -m) \
-o minimaldoc
chmod +x minimaldoc
Initialize
Create your docs folder with example content
minimaldoc init my-docsBuild
Generate your static site
minimaldoc buildDeploy
Upload the public directory to any static host
# Any static web hostingResources
Open Source
GPL-3.0 Licensed. Self-host your documentation with full control. Built by Studio Webux.