一句话MinimalDoc 是一款基于 Go 开发的开源轻量级静态文档站点生成器,可同时满足文档、API、状态页等多种技术站点搭建需求
定价免费开源 遵循 GPL-3.0 协议完全免费,无付费订阅或功能限制
适合谁开发者、技术团队、开源项目维护者、小型创业团队
核心功能基于 Markdown + YAML 前置元数据写作,无需复杂配置Go 语言开发,毫秒级生成完整站点,性能优异自动适配明暗主题,支持本地存储持久化客户端全文搜索,支持快捷键操作OpenAPI 支持,可生成交互式API文档、支持端点测试、代码示例与 schema 可视化支持搭建服务状态页,可记录事件、维护窗口、正常运行时间指标,提供 RSS 订阅自动从 Markdown 发布说明生成变更日志,支持 RSS 订阅支持营销型着陆页、带筛选标签的项目作品集页面内置SEO优化,支持sitemap.xml、元标签、llms.txt,提供干净URL支持100+语言代码高亮,自带代码复制按钮,完整支持GitHub Flavored Markdown生成的静态文件可部署到任意静态主机完全开源可自托管
功能与用途MinimalDoc 是面向文档的静态站点生成器,可将 Markdown 文件转换为快速、干净的 HTML 文档站。支持文档站、OpenAPI 交互式 API 文档、状态页、变更日志、路线图、落地页、作品集、FAQ、知识库、法律页面等。输出为纯 HTML/CSS/JavaScript,适合 CI/CD 自动构建并部署到任意静态托管。
支持语言/框架工具本身使用 Go 构建。内容编写支持 Markdown、GitHub Flavored Markdown 和 YAML frontmatter。语法高亮通过 Chroma 支持 100+ 编程语言,文本列举 Go、JavaScript、TypeScript、Python、Rust、C/C++、Swift、Ruby、PHP、Shell、SQL、GraphQL、Terraform 等。
开源还是闭源开源,GPL-3.0 Licensed,源码和 issues 位于 GitHub。
自托管选项支持完全自托管。构建结果为纯静态文件,可上传到任意静态 Web hosting;不需要服务器运行时、数据库或后端服务。支持从源码构建、Go install、预编译二进制安装。
定价免费开源。FAQ 明确说明 MinimalDoc is free,采用 GPL-3.0 许可证。未提供付费版或商业托管价格。
API/SDK提供 CLI 命令,包括 build、init、version、help;有 CLI flags、环境变量、配置优先级和 shell completion。支持从 OpenAPI 3.x 规范生成交互式 API 文档,支持 API 测试、认证、代码样例和 schema 浏览。文本未提及作为服务的外部 API 或 SDK。
集成与生态可与 GitHub、GitHub Releases、Go install、CI/CD、静态托管、OpenAPI/Swagger、Prometheus 集成;支持 GitHub Pages 部署指南、远程 OpenAPI spec 拉取、RSS feeds、llms.txt、MCP Server Docs、Claude Assist 等文档入口。
文档质量文档结构较完整,包含安装、快速开始、配置、核心概念、功能索引、CLI 参考、OpenAPI、状态页、变更日志、部署和自定义主题等栏目;页面有版本切换、多语言入口、搜索、示例命令、配置片段和功能矩阵,整体信息密度较高。
中国访问可直连
适用场景['开源项目文档搭建''团队内部技术文档发布''API接口文档生成与展示''服务状态监控页搭建''个人开发者项目作品集展示']
同类Docusaurus、MkDocs、VitePress、Nextra、Hugo、Docsify