README
¶
MinimalDoc
A minimal static site generator for documentation. Fast, clean, and easy to use.
Work in Progress
The static site generator (
minimaldoc build) is stable and production-ready. The backend server (minimaldoc-server) is in early development — not ready for production use. APIs may change, features are largely untested end-to-end.
Features
| Category | Features | Status |
|---|---|---|
| Content | Markdown (GFM), Frontmatter, Admonitions, Syntax Highlighting, Link Checking, Copy-to-Markdown | Stable |
| Navigation | Auto-generated from folders, Custom TOC.md, Page TOC with scrollspy | Stable |
| Search | Full-text index, Cmd+K shortcut, Fuzzy matching, Section-level results | Stable |
| Design | Dark/Light mode, Responsive, Custom themes via YAML, Custom fonts | Stable |
| Versioning | Multi-version docs, Version selector, EOL warnings | Stable |
| i18n | Multi-locale, Translation files, RTL support | Stable |
| Pages | Landing, Knowledge Base, Portfolio, FAQ, Legal, Status, Changelog, Roadmap | Stable |
| API Docs | OpenAPI 3.0/3.1, Live testing, Code samples, Schema viewer, MCP server docs from JSON manifests | Stable |
| SEO | Sitemap, Open Graph, Twitter Cards, llms.txt | Stable |
| Analytics | GA4, Plausible, Umami, Matomo provider integrations | Stable |
| Backend | Optional server (minimaldoc-server): cookie-free analytics, feedback widget, newsletter, blog CMS (RBAC, scheduling, RSS, comments), private docs, image uploads (local + S3), OAuth/JWT auth, admin portal, custom events, PDF export |
WIP |
| Forum | Via backend server: categories, topics, replies, likes, bookmarks, reputation, moderation, bans, notifications, search | WIP |
Quick Start
# Install
git clone https://github.com/studiowebux/minimaldoc
cd minimaldoc && go build -o minimaldoc cmd/minimaldoc/main.go
# Create and build site
minimaldoc init my-docs && cd my-docs && minimaldoc build
Documentation
The docs/ directory is a demo site — it exists to showcase what MinimalDoc
can generate and to test the generator itself. It is not the authoritative
documentation for this project.
| Topic | Link |
|---|---|
| Getting Started | docs/getting-started/ |
| Configuration | docs/core-concepts/ |
| Features | docs/features/ |
| OpenAPI | docs/openapi/ |
| Status Page | docs/status-page/ |
| Backend Server | docs/features/12-backend.md |
| Forum | docs/features/13-forum.md |
| Deployment | deploy/ |
License
See LICENSE file.
Credits
Created by Studio Webux
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
minimaldoc
command
|
|
|
minimaldoc-server
command
Package main provides the entrypoint for minimaldoc-server.
|
Package main provides the entrypoint for minimaldoc-server. |
|
internal
|
|
|
core
Package core provides consolidated default configuration functions.
|
Package core provides consolidated default configuration functions. |
|
server/api
Package api provides the HTTP API handlers for minimaldoc-server.
|
Package api provides the HTTP API handlers for minimaldoc-server. |
|
server/auth
Package auth provides authentication for minimaldoc-server.
|
Package auth provides authentication for minimaldoc-server. |
|
server/config
Package config provides configuration management for minimaldoc-server.
|
Package config provides configuration management for minimaldoc-server. |
|
server/email
Package email provides pluggable email sending for minimaldoc-server.
|
Package email provides pluggable email sending for minimaldoc-server. |
|
server/markdown
Package markdown provides markdown rendering services for the server.
|
Package markdown provides markdown rendering services for the server. |
|
server/ratelimit
Package ratelimit provides rate limiting middleware for the HTTP server.
|
Package ratelimit provides rate limiting middleware for the HTTP server. |
|
server/scheduler
Package scheduler provides background job scheduling for minimaldoc-server.
|
Package scheduler provides background job scheduling for minimaldoc-server. |
|
server/storage
Package storage provides file storage abstractions for minimaldoc-server.
|
Package storage provides file storage abstractions for minimaldoc-server. |
|
server/store
Package store provides database access for minimaldoc-server.
|
Package store provides database access for minimaldoc-server. |
|
server/telemetry
Package telemetry provides OpenTelemetry initialization for minimaldoc-server.
|
Package telemetry provides OpenTelemetry initialization for minimaldoc-server. |
Click to show internal directories.
Click to hide internal directories.