从安装到部署Mike工具快速入门教程【免费下载链接】mikeManage multiple versions of your MkDocs-powered documentation via Git项目地址: https://gitcode.com/gh_mirrors/mi/mikeMike是一款强大的Python工具专为管理基于MkDocs的多版本文档而设计通过Git实现轻松部署。本教程将带你快速掌握Mike工具的安装、配置和核心使用方法让你轻松管理多个版本的文档。为什么选择Mike工具Mike工具围绕一次生成永久使用的理念设计生成特定版本的文档后无需再次修改。这意味着你无需担心MkDocs的版本更新可能带来的兼容性问题因为旧版本文档已经生成并存储在gh-pages分支中。Mike的优势在于灵活管理多个文档版本支持版本别名如latest或dev优化的目录结构便于创建永久链接与Git无缝集成适合GitHub Pages托管快速安装Mike工具安装Mike非常简单使用pip命令即可pip install mike如果你希望设置shell自动补全功能可以安装shtab后运行mike generate-completion配置MkDocs插件Mike通过MkDocs插件集成到构建流程中默认情况下会自动添加。你也可以在mkdocs.yml中显式配置plugins: - mike: alias_type: symlink redirect_template: null deploy_prefix: canonical_version: null version_selector: true css_dir: css javascript_dir: js主要配置选项说明alias_type: 别名创建方式symlink、redirect或copyversion_selector: 是否显示版本选择器css_dir和javascript_dir: 版本选择器的资源文件目录部署文档版本部署当前版本的文档非常简单只需运行mike deploy [version]其中[version]是你的项目版本号建议使用[major].[minor]格式。你还可以为版本添加别名mike deploy [version] [alias]...例如部署1.0版本并添加latest别名mike deploy 1.0 latest如果需要更新已存在的别名可以使用-u/--update-aliases选项mike deploy 1.1 latest -u部署时可以指定标题mike deploy 1.0 --title Version 1.0.0要将文档推送到远程仓库添加-p/--push选项mike deploy 1.0 -p本地预览文档在编辑文档时可以使用MkDocs的内置命令预览当前版本mkdocs serve如果要预览所有已部署的版本可以使用Mike的serve命令mike serve默认情况下文档将在http://localhost:8000提供访问你可以使用-a选项指定不同的地址和端口。注意mike serve和mkdocs serve仅用于测试生产环境应使用正式的Web服务器。管理文档版本列出所有版本要查看所有已部署的文档版本使用mike list要查看特定版本的信息只需指定版本名或别名mike list [identifier]如需以JSON格式输出方便其他工具处理使用-j/--json选项mike list -j删除文档版本删除某个版本及其所有别名mike delete [version]仅删除某个别名mike delete [alias]要完全清空文档分支使用mike delete --all设置默认版本设置默认版本使访问网站根目录时重定向到该版本mike set-default [identifier]例如将latest设为默认版本mike set-default latest修改版本标题更改现有版本的标题mike retitle [identifier] [new_title]例如mike retitle 1.0 Version 1.0.1添加版本别名为现有版本添加新别名mike alias [identifier] [new_alias]...例如为1.0版本添加stable别名mike alias 1.0 stable版本属性管理每个文档版本可以分配任意属性用于存储额外元数据。内置主题支持hidden属性设为true时将在版本选择器中隐藏该版本当前版本除外。查看版本属性mike props [identifier] [prop]设置属性mike props [identifier] --set propjson例如隐藏某个版本mike props 0.9 --set hiddentrue在CI中部署Mike可以轻松集成到CI系统中。由于CI系统通常使用浅克隆需要先获取文档分支git fetch origin gh-pages --depth1还需要配置Git用户信息git config user.name ci-bot git config user.email ci-botexample.com或者设置环境变量GIT_COMMITTER_NAMEci-bot GIT_COMMITTER_EMAILci-botexample.com mike deploy 1.0总结Mike工具为MkDocs文档提供了强大的多版本管理能力通过简单的命令即可实现文档的部署、版本控制和预览。无论是个人项目还是企业级文档Mike都能帮助你轻松管理多个文档版本确保用户始终能访问到正确的文档内容。要了解更多详细选项请查看mike --help命令或项目的官方文档。【免费下载链接】mikeManage multiple versions of your MkDocs-powered documentation via Git项目地址: https://gitcode.com/gh_mirrors/mi/mike创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考