跳转至

Blog

为MkDocs转换材料

我们正在开发一套令人惊叹的功能,这需要一些幕后工作,我们现在准备在一系列帖子中分享。在这里,我们概述了我们的目标、正在开发的功能、让我们彻夜难眠的事情以及我们对开源的承诺。

我们知道,自上次更新以来已经有一段时间了,这就是为什么我们渴望与您分享Material for MkDocs内部和周围发生的事情。在2024年的大部分时间里,我们一直专注于改造MkDocs材料的核心,为最常被要求的新的、相互关联的功能奠定基础。

本文是系列文章中的第一篇,我们将探讨如何通过改进信息检索来支持用户,为多语言网站和版本控制提供更好的支持,以及改善整体创作体验。我们概述了我们对项目发展的愿景,并描述了我们一直在做的工作。在这篇和接下来的博客文章中,我们将与您分享我们的进展,我们很高兴听到您的想法。

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秒。

博客支持刚刚落地

嘿!您正在查看我们的新博客,它是用全新的 [内置博客插件]。使用此插件,您可以轻松地在旁边构建博客 您的文档或独立文件。

根据过去几年许多用户的要求,对博客提供适当的支持, 这是MkDocs功能集的Material中迫切缺少的东西。 虽然每个人都同意博客支持是一个盲点,但事实并非如此 很明显,MkDocs是否可以扩展到允许像我们这样的博客 从[杰基尔]和朋友那里知道。[内置博客插件]证明了这一点, 毕竟,可以在MkDocs的基础上构建一个博客引擎,以便 在文档旁边创建一个技术博客,或者作为主要内容。

Chinese search support – 中文搜索​支持

内部人士为[内置搜索]添加了实验性的中文支持 插件]–一个长期以来被要求的功能 中国用户数量。

仅次于美国和德国的第三大原产国 MkDocs用户的材料是中国。长期以来,[内置搜索插件] 不允许对汉字进行适当的分割,主要是因为 [lunr语言]中缺少用于搜索标记化和 堵塞。Insiders最新版本增加了期待已久的中文支持 对于内置的搜索插件,这是许多用户所要求的。

过去、现在和未来

2021年对这个项目来说是美好的一年,因为我们推出了许多新的、令人惊叹的产品 功能,用户增长显著,并利用GitHub赞助商使 项目可持续。

今天,MkDocs和MkDocs材料是最受欢迎的 为您的网站选择静态站点生成器和主题时的选项 技术文档项目。MkDocs的材料确保您 无论屏幕如何,内容总是完美地呈现给观众 分辨率或设备性能。它已经发展成为一个技术框架 写作,提供许多功能,其中一些功能在其他网站上尚未发现 静态站点生成器。然而,我们还远未结束,因为2022年即将到来 带来一些有趣的新功能。

从搜索中排除内容

最新的Insiders版本带来了三种新的简单排除方法 从搜索索引中提取文档的专用部分,允许更多 精细控制。

两周前,Material for MkDocs Insiders发布了一个全新的搜索 插件],带来了[可用性的巨大改进],但也提高了[速度 以及搜索索引的大小。有趣的是,如前所述 在博客文章中,我们只是触及了现在可能实现的表面。这 发布带来了一些有用的功能,增强了写作体验, 允许对页面、部分和块进行更细粒度的控制 Markdown文件应该通过内置的搜索功能进行索引。

搜索:更好、更快、更小

这是我们如何设法完全重建客户端搜索的故事, 提供更好的用户体验,同时使其更快 同时变小。

MkDocs的材料搜索是迄今为止最好、最受欢迎的搜索之一 资产:[多语言],[离线功能],最重要的是:全部 客户端_。它提供了一种解决方案,可以增强文档用户的能力 立即找到他们正在寻找的东西,而不必担心管理问题 额外的服务器。然而即使已经进行了几次迭代, 还有一些改进的空间,这就是我们重建搜索的原因 插件和集成从头开始。这篇文章对 新搜索的内部结构,为什么它比以前强大得多 版本,以及即将到来的内容。