跳转至

2023

Adding a badge to your project

你喜欢使用MkDocs的Material吗?分享爱!您现在可以添加 项目README的徽章,显示您的项目是用 MkDocs的材料。

MkDocs徽标的材料刚刚添加到Simple Icons中,该图标由 Shields.io在徽章中包含徽标。我们为您生成了一个徽章 您可以添加到项目的README中:

Material for MkDocs

Sunsetting Gitter:迈向高效的社区参与

当我们开始围绕MkDocs的Material组建一个团队时,我们决定 日落,并于2023年10月13日存档我们的Gitter频道,以支持 [GitHub讨论]。

作为我们努力改进材料维护流程的一部分 为了支持社区,我们审查了不同文档的使用情况 沟通渠道。目前,Gitter和[GitHub讨论] 允许向社区寻求支持,讨论想法和问题。在the 过去几周,我们开始质疑这种重复是否是最好的 我们项目的兴趣。这篇文章解释了我们决定背后的基本原理。

使用git sparse checkout实现更快的文档构建

利用GitHub Actions中的“git sparse checkout”使我们能够加快速度 文档构建在我们的存储库中,将结账时间从20缩短到30 秒到2秒。

开发一种在CI工作流中构建文档的有效方法 至关重要,尤其是在拥有数千个存储库的大型存储库中工作时 承诺,就像我们一样。当然,我们希望快速构建文档 高效,确保快速高效的工作流程。当同时使用时 很棒的[git提交者][git提交者]和[git修订日期本地化] [git修订日期本地化]插件,用于显示[文档贡献者]和 在每页底部的[日期]处,我们需要设置“获取深度:0”, 这导致我们的存储库的结账时间为20到30秒。By 在GitHub Actions中利用[git sparse checkout][git sparse checkout], 退房时间缩短到2秒。