mkdocs插件,显示基于git标记的最新版本。
mkdocs-latest-release-plugin的Python项目详细描述
mkdocs最新版本插件
用于mkdocs将git标记注入标记的插件。主要目的是允许mkdocs站点与github中的应用程序位于同一存储库中,根据git标记显示最新发布的版本。
起源和目的
这个插件是专门为支持github项目而创建的,它使用github页面和mkdocs发布文档,这些文档还使用标记来标记发布。一个很好的例子就是编写jenkins共享库和相关文档。用户使用存储库源和git标记来指定版本,从而克隆共享库。共享库的文档位于同一个存储库中,因此确保文档得到更新可以成为请求/审阅过程的一部分,但是并不是所有要主控的合并都会被释放。最初,在文档中引用最新版本是有用的,但这很快就过时了,因为并不是所有到master的合并都已发布,所以手动维护它是不实际的,而且通常不应该手动维护任何不必维护的内容。因此,需要将这个插件添加到mkdocs中,用于jenkins共享库代码的自动构建和发布过程。
安装
pip install mkdocs_latest_release_plugin
用法
在mkdocs.yml
plugins:-search-git-latest-release
将{{ git_latest_release }}
添加到标记中要引用最新版本标记的任何位置。释放标记被假定为语义版本标记,因此与regex\d+\.\d+\.\d+
匹配。