用途:该技能用于借助 MkDocs 与 Material 主题,从 Markdown 构建和维护静态文档站点,并按任务类型加载对应参考文件。
主要能力:按任务分流加载参考,包括 CLI 参考(new、build、serve、gh-deploy 子命令、全局标志、环境变量与退出码)、配置参考(mkdocs.yml 的项目信息、nav、docs_dir/site_dir、theme 块、Markdown 扩展、插件注册、hooks 及 INHERIT 多文件配置继承)、Material 主题参考(配色与明暗切换、排版、导航特性如标签页、分节、即时加载、搜索、社交卡片、mike 版本化、Git 仓库集成、图标与徽标)、插件参考(mkdocstrings、mkdocs-gen-files、mkdocs-literate-nav、mkdoxy、mkdocs-typer2、mermaid2、termynal、mkdocs-git-latest-changes-plugin)以及真实案例参考(GitHub Pages 与 GitLab Pages 的 CI/CD 工作流、使用 MkDocs 的开源仓库、多插件配置模式)。
使用方式:快速开始命令为 uv add --dev mkdocs mkdocs-material、uv run mkdocs new .、uv run mkdocs serve(本地预览 http://127.0.0.1:8000)、uv run mkdocs build(生成 site/)、uv run mkdocs gh-deploy(发布到 GitHub Pages)。最小 mkdocs.yml 含 site_name、theme.name: material 与 nav。
适用场景:新建项目脚手架、本地预览、生产构建、CLI 部署到 GitHub Pages、编写或编辑 mkdocs.yml、定制 Material 主题外观与导航、集成插件或从源码生成文档、搭建部署流水线。
限制:资料未提供具体收费、价格、平台支持范围与效果数据;各参考文件自带官方资源章节,主要来源为 mkdocs.org、squidfunk.github.io/mkdocs-material 与 github.com/mkdocs/catalog。