入门

DocsForge 是一款自包含的文档引擎。pip install，编写 Markdown，构建完成。

安装

pip install docsforge

需要 Python 3.10+。

# 交互式创建新项目
docsforge
cd my-docs

# 启动开发服务器
docsforge serve

# 构建生产版本
docsforge build

运行 docsforge 创建项目后，目录结构如下：

my-docs/
├── docsforge.yml    # 站点配置
├── docs/
│   └── index.md     # 首页
└── site/            # 构建输出

最小的有效 docsforge.yml：

site_name: My Project

就这些。所有插件、扩展和主题设置都使用合理的默认值。仅在需要自定义时添加配置。

功能	默认值
主题	Material（内置）
插件	search、tags、blog、info、meta、minify、privacy
Markdown 扩展	共 31 个 —— 全部 pymdownx + python-markdown
数学公式	KaTeX（已内置，`$$...$$` 可用）
代码高亮	Pygments（彩色语法）
深色模式	页眉中的浅色/深色切换
字体	自托管（privacy 插件下载 Google Fonts）
图表	TikZ 支持（自动编译为 SVG）
离线	服务工作者缓存所有资源