Documentation Made Simple

A minimal static site generator for documentation. Fast, clean, and easy to use. 

$ minimaldoc init my-docs
$ minimaldoc build
Download Binary View on GitHub

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.

Auto Navigation

Automatic navigation tree generated from folder structure. Or use custom TOC.md for full control.

Flexible Configuration

Configure via CLI flags or config.yaml file. Control themes, navigation, output paths, and more with simple configuration options.

LLM-Friendly

Generates llms.txt for AI assistants. Documentation optimized for modern workflows.

Syntax Highlighting

Beautiful code blocks with syntax highlighting. Support for all major programming languages.

Deploy Anywhere

Static HTML output. Works with GitHub Pages, Netlify, Vercel, or any static host.

Table of Contents

Auto-generated table of contents with active scrollspy. Navigate long documents with ease.

Admonitions

Beautiful callout blocks for info, warning, danger, success, note, and question types.

GFM Support

Full GitHub Flavored Markdown support. Tables, strikethrough, task lists, and more.

SEO Optimized

Automatic sitemap.xml generation for better search engine visibility and discoverability.

OpenAPI/Swagger

Interactive API documentation with live testing capabilities. Import OpenAPI specs and test endpoints directly from your documentation.

Fully Responsive

Mobile-first, responsive design. Perfect reading experience on any device or screen size.

Quick Start

1. Download Binary

Download the binary for your platform from GitHub releases. 

curl -L https://github.com/studiowebux/minimaldoc/releases/latest/download/minimaldoc-[OS]-[ARCH] -o minimaldoc
chmod +x minimaldoc

2. Initialize Project

Create a new documentation project with sample files and configuration. 

minimaldoc init my-docs
cd my-docs

3. Configure (Optional)

Customize your documentation using config.yaml. Set title, theme, navigation, and OpenAPI specs. 

# Edit config.yaml
title: "My Documentation"
theme: "yellow"
openapiPath: "openapi.yaml"

4. Build

Generate your static documentation site.

minimaldoc build

5. Deploy

Upload the public directory to your hosting provider. 

cd public
# Deploy to your hosting provider

Open Source

MinimalDoc is free and open source software licensed under GPL-3.0. Self-host your documentation with full control.

GitHub Repository Download Releases GPL-3.0 License