SuperAPI AI 工具集

mkdocs

前端与建站

查看项目

更新于 10-15 23:42

技能介绍

用途:MkDocs 是面向项目文档的静态站点生成器,从 Markdown 文件构建文档站,配置集中在 mkdocs.yml。

主要能力:内置 mkdocs、readthedocs 主题,支持第三方主题(如 mkdocs-material);内置全文搜索,可启用 blog、tags 等插件;支持 toc、tables、fenced_code、admonition 等 Markdown 扩展;支持页面元数据、显式或自动导航、自定义 CSS/JS;可将站��构建为静态文件或部署到 GitHub Pages。

使用方式:安装 pip install mkdocs;mkdocs new my-project 创建结构(mkdocs.yml 与 docs/index.md);mkdocs serve 在 localhost:8000 预览;mkdocs build 输出到 site/;mkdocs gh-deploy 部署到 GitHub Pages。常用选项包括 -f 指定配置、-s 警告即失败、-d 指定输出目录、--dirty 仅重建变更、--clean 构建前清理。主题在 mkdocs.yml 的 theme 段配置。

适用场景:需要从 Markdown 快速生成项目文档站、API 参考、用户指南并发布到静态托管或 GitHub Pages 的团队。

限制与注意事项:在 mkdocs.yml 中定义 plugins 会禁用默认 search 插件,需显式加入 - search,否则页面不被索引、搜索无效;mkdocs serve 不监视 include_dir 或主题覆盖文件,修改 custom_theme 后需重启;gh-deploy 会强推 gh-pages,手动改动会被覆盖,勿手改该分支;use_directory_urls 为 true 时 page.md 变成 page/,原始相对链接可能在部署后失效;strict 开启后未识别配置键也会导致构建失败,需先确认主题兼容;Material 的 navigation.instant 会破坏页面加载时运行的第三方 JS,需改用 document$.subscribe();--dirty 不检测导航或主题配置变更,可用 --clean 或删除 site/。

其他细节:官方文档未在资料中提供,具体参见其 references 目录。