DocsForge
用 Markdown 编写文档。数秒内构建专业的静态站点。随处部署。
从 MkDocs 迁移而来?
DocsForge 是 MkDocs + Material for MkDocs 的积极维护继任者。
查看迁移指南,了解如何手动迁移您的项目。
pip install docsforge
docsforge serve
DocsForge 有什么不同
零依赖
所有功能均已内置。
pip install docsforge即可获得文档引擎、Material 主题、全部插件、全部扩展、字体、图标、数学渲染和服务工作者。零配置
只需
site_name:即可开始。全部 7 个插件和 31 个 Markdown 扩展会自动加载。仅在需要时进行自定义。数学公式可用
编写
$$...$$即可渲染。KaTeX 已内置 —— 读者端无需调用 CDN,无需extra_javascript,无需额外设置。语法高亮
代码块在构建时使用 Pygments 着色。无需客户端 JavaScript。
即时搜索
内置全文搜索,由客户端 Lunr.js 索引驱动。
深色模式
页眉中提供浅色/深色切换。自动检测系统偏好。
TikZ 图表
直接在 Markdown 中编写 TikZ。构建时自动编译为 SVG。
博客
内置博客,支持作者、标签、归档、分页和 RSS 订阅源。
离线支持
服务工作者缓存所有资源。无需互联网连接即可工作。
快速开始
pip install docsforge
docsforge # 以交互方式创建新项目
cd my-docs
docsforge serve
就是这样。您的文档站点现在运行在 localhost:8000。
内置功能
| 功能 | 状态 |
|---|---|
提示框 (!!! note) | 零配置 |
数学公式 ($$...$$) | 零配置 |
| 代码高亮 | 零配置 |
| 表格 | 零配置 |
任务列表 (- [x]) | 零配置 |
脚注 ([^1]) | 零配置 |
| 定义列表 | 零配置 |
| 缩写 | 零配置 |
| 内容标签页 | 零配置 |
| 图表(Mermaid、TikZ) | 零配置 |
| 表情符号 | 零配置 |
| 博客 | 零配置 |
| 标签 | 零配置 |
| 搜索 | 零配置 |
| 隐私(自托管资源) | 零配置 |
| 压缩(HTML/CSS/JS) | 零配置 |
| 离线/PWA | 零配置 |