Skip to content

General

  • 2024年8月19日

  • 一般来说

    ¥ in

  • 阅读需14分钟

    ¥ 14 min read

为 MkDocs 转换材料

¥Transforming Material for MkDocs

我们正在开发一系列令人惊叹的功能，这其中涉及一些幕后工作，现在我们准备通过一系列博文来分享。在这里，我们将概述我们的目标、正在开发的功能、那些让我们夜不能寐的事情，以及我们对开源的承诺。

¥We are working on an amazing set of features which has required some behind-the-scenes work we are now ready to share in a series of posts. Here, we give an overview of our goals, features in the making, things that kept us up at night, and our commitment to Open Source.

我们知道距离上次更新已经有一段时间了，因此我们迫切地想与您分享 Material for MkDocs 及其周边的最新动态。在 2024 年的大部分时间里，我们一直专注于改造 Material for MkDocs 的核心，为最常被请求的新功能、互联功能奠定基础。

¥We know it's been quite a while since our last update, which is why we're eager to share what's happening in and around Material for MkDocs with you. For the largest part of 2024, we've been focused on transforming the core of Material for MkDocs preparing the ground for new, interconnected features that are amongst the most frequently requested.

本文是系列文章的第一篇，我们将探讨如何通过改进信息检索功能来支持用户，更好地支持多语言网站和版本控制，并提升整体创作体验。我们将概述项目发展的愿景，并介绍我们目前的工作内容。在本篇及后续博文中，我们将与您分享我们的进展，并期待听到您的想法。

¥This article is the first in a series where we'll explore how we aim to support our users through improved information retrieval, provide better support for multi-lingual sites and versioning, as well as improve the overall authoring experience. We outline our vision for the projects' evolution and describe what we have been working on. In this and the coming blog posts, we will share our progress with you, and we're excited to hear your thoughts.

  • 2023年11月30日

  • 一般来说

    ¥ in

  • 阅读需 1 分钟

    ¥ 1 min read

向您的项目添加徽章

¥Adding a badge to your project

您喜欢使用 Material for MkDocs 吗？分享您的爱！现在，您可以在项目的 README 文件中添加徽章，以表明您的项目是使用 Material for MkDocs 构建的。

¥You enjoy working with Material for MkDocs? Share the love! You can now add a badge to your project's README, showing that your project is built with Material for MkDocs.

MkDocs 徽标的素材刚刚添加到Simple Icons中， Shields.io使用它来将徽标包含在徽章中。我们为您生成了一个徽章，您可以将其添加到项目的 README 中：

¥Material for MkDocs' logo was just added to Simple Icons, which is used by Shields.io to include logos in badges. We generated a badge for you, which you can add to your project's README:

  • 2023年10月2日

  • 一般来说

    ¥ in

  • 阅读需3分钟

    ¥ 3 min read

Gitter 的落幕：迈向高效的社区参与

¥Sunsetting Gitter: Towards Efficient Community Engagement

当我们开始围绕 MkDocs 的 Material 组建团队时，我们决定在 2023 年 10 月 13 日关闭并存档我们的 Gitter 频道，转而使用 GitHub Discussions。

¥As we're starting to build a team around Material for MkDocs, we've decided to sunset and archive our Gitter channel on October 13, 2023 in favor of GitHub Discussions.

为了改进 MkDocs 材料维护流程并支持社区，我们审查了不同沟通渠道的使用情况。目前， Gitter和GitHub 讨论区都允许向社区寻求支持，并讨论想法和问题。在过去几周，我们开始质疑这种重复是否符合我们项目的最佳利益。这篇文章解释了我们做出这一决定背后的原因。

¥As part of our efforts to improve the processes for maintaining Material for MkDocs and for supporting the community, we have reviewed the use of different communication channels. At the moment, both Gitter and GitHub Discussions allow to ask the community for support and to discuss ideas and issues. In the past weeks, we have begun to question whether this duplication is in the best interest of our project. This post explains the rationale behind our decision.

  • 2021年12月27日

  • 一般来说

    ¥ in

  • 阅读需6分钟

    ¥ 6 min read

过去、现在和未来

¥The past, present and future

2021 年对于这个项目来说是辉煌的一年，因为我们推出了许多出色的新功能，用户数量显著增长，并利用 GitHub 赞助商使项目可持续发展。

¥2021 was a fantastic year for this project as we shipped many new awesome features, saw significant user growth and leveraged GitHub Sponsors to make the project sustainable.

如今，在为您的技术文档项目选择静态站点生成器和主题时， MkDocs和 Material for MkDocs 是最受欢迎的选择之一。Material for MkDocs 确保您的内容始终完美呈现给受众，无论屏幕分辨率或设备功能如何。它已经发展成为一个技术写作框架，提供许多功能，其中一些功能在其他静态站点生成器中尚不可用。然而，这远未结束，因为 2022 年将带来一些有趣的新功能。

¥Today, together, MkDocs and Material for MkDocs are among the most popular options when it comes to choosing a static site generator and theme for your technical documentation project. Material for MkDocs ensures that your content is always perfectly presented to your audience, regardless of screen resolution or device capabilities. It has evolved to a framework for technical writing, offering many features, some of which are yet to be found in other static site generators. However, we're far from the end, as 2022 is going to bring some interesting new capabilities.