跳转至

教程

除了基本的入门指南外,我们还提供旨在 展示如何在不同用例中使用MkDocs的Material。与…对比 入门指南或参考文档,教程显示 MkDocs材料中可用的功能范围,以及 更广泛的MkDocs生态系统。

教程将指导您完成工作示例,因此通过遵循这些示例,您应该 不仅要了解如何使用Material for MkDocs,还要 您自己项目的模板。为了方便起见,这些模板也是 可作为GitHub上的模板存储库使用。

教程假设您已经安装了public versionInsiders editionMaterial for MkDocs,您已经完成了 creating your site设置指南。

请注意,如果我们使用的功能需要Insiders版本,我们会标记这些 带有心形图标: 如果您使用的是公共版本 那么你可以跳过这些步骤。有时会有一些方法来实现 公开版和内幕版的目标相同。在……里面 在这种情况下,我们将在选项卡视图中显示它们,以便您可以看到其中一个。

需要反馈!

这些教程是我们文档中最近添加的,我们仍然 弄清楚它们最终应该有什么形状。 Please provide any feedback you might have in this discussion thread.

但请注意,建议应该具体可行。我们想 现在专注于创造更多的内容,而不是开发 教程的特定样式或行为。如果有值得 我们可以通过简单的定制进行改进,然后我们很高兴 考虑这些。

博客

Template Repository

社交卡

  • Basics (20 min)
    向您展示了如何配置MkDocs的材料,以创建社交卡 您的内容。
  • Custom cards (15 min)
    向您展示如何设计自己的自定义社交卡。

Template Repository