Skip to content

教程

¥Tutorials

除了基本的入门指南外，我们还提供教程，旨在展示如何在不同的用例中使用 Material for MkDocs。与入门指南或参考文档不同，这些教程不仅展示了 Material for MkDocs 的丰富功能，还涵盖了更广泛的 MkDocs 生态系统。

¥In addition to the basic getting started guides, we offer tutorials that aim to show how you can use Material for MkDocs in different use cases. In contrast to the getting started guides or the reference documentation, the tutorials show the breadth of features available in Material for MkDocs but also within the wider MkDocs ecosystem.

这些教程将指导您完成一些示例，因此通过学习这些示例，您不仅可以了解如何在 MkDocs 中使用 Material，还可以获得适用于您自己项目的模板。为了方便起见，这些模板也可以在 GitHub 上作为模板存储库使用。

¥The tutorials guide you through worked examples, so by following them you should gain not only an understanding of how to use Material for MkDocs, but also a template for your own projects. For convenience, these templates are also available as template repositories on GitHub.

本教程假设您已经安装了 Material for MkDocs 的公共版本或Insiders 版本，并且您已经完成了站点设置指南的创建。

¥The tutorials assume that you have installed either the public version or the Insiders edition of Material for MkDocs and that you have worked through the creating your site setup guide.

请注意，我们使用的功能需要 Insiders 版本，我们会用心形图标标记这些功能：如果您使用的是公共版本，则可以跳过这些步骤。有时，公共版本和 Insider 版本之间实现同一目标的方法会有所不同。在这种情况下，我们将以标签视图的形式显示它们，以便您查看其中一种。

¥Note that where the features we use require the Insiders edition, we mark these with the heart icon: If you are using the public version then you can skip these steps. Sometimes there will be ways of achieving the same goal that differ between the public version and the Insider edition. In that case, we will show them in a tabbed view so you can see one or the other.

需要反馈！

¥Feedback wanted!

这些教程是我们最近添加到文档中的，我们仍在研究最终的版本。如有任何反馈，请在此讨论帖中留言。

¥The tutorials are a recent addition to our documentation and we are still working out what shape they should have in the end. Please provide any feedback you might have in this discussion thread.

但请注意，建议必须具体可行。我们目前专注于创作更多内容，而不是为教程开发特定的样式或行为。如果通过简单的定制就能做出有价值的改进，我们很乐意考虑。

¥Note, however, that suggestions should be specific and feasible. We want to focus on creating more content at the moment, instead of developing a specific styling or behaviour for the tutorials. If there are worthwhile improvements that we can make through simple customization then we are happy to consider those.

博客

¥Blogs

模板存储库

¥ Template Repository

社交卡

¥Social cards

  • 基础知识（20 分钟）

    ¥Basics (20 min)


    向您展示如何配置 Material for MkDocs 来为您的内容创建社交卡。

    ¥ shows you how to configure Material for MkDocs to create social cards for your content.

  • 自定义卡片（15 分钟）

    ¥Custom cards (15 min)


    向您展示如何设计您自己的自定义社交卡。

    ¥ shows you how to design your own custom social cards.

模板存储库

¥ Template Repository