菜单
开源
最后审阅日期:2024 年 8 月 22 日

章节页面

章节页面,也称为着陆页,将用户引导至该章节中最有价值的资源。

章节结构

一个 *章节* 页面包含以下元素

  • 英雄部分 (Hero): 页面顶部的横幅,包含章节标题和简要描述。
  • 概述 (Overview): 一个标题和一到两个段落,描述章节中包含的资源。
  • 探索 (Explore): 一个包含卡片的标题。
    • 卡片 (Cards): 在 front matter 中定义,卡片提供重要页面的概览,并包含指向这些页面的链接。

编写章节页面

要编写一个章节,请按照以下步骤操作

  1. 确定您要添加章节的位置,或查找现有章节页面进行更新。

  2. 如果您要创建一个新章节,请创建一个遵循此命名约定的目录

    • 目录名称应与该章节计划的菜单标题匹配。
    • 使用小写字母。
    • 在单词之间添加连字符。
  3. 在章节目录中创建一个 _index.md 文件。

  4. 向 index 文件添加常用的 front matter。

    有关 front matter 的更多信息,请参阅Front matter

  5. 添加章节页面的特定元素

    • 英雄部分 (Hero): 一个 英雄部分 需要 front matter 并使用 shortcode。
    • 卡片 (Cards): 一个 卡片网格 需要 front matter 并使用 shortcode。

章节页面示例

请参阅以下页面查看章节页面示例

章节模板

准备好写作时,复制章节模板并添加您的内容。