在 Markdown 中创作内容
Starlight 支持在 .md
文件中使用完整的 Markdown 语法,以及使用 YAML 定义metadata 元数据,例如标题和描述。
如果使用这些文件格式,请务必检查 MDX 文档 或 Markdoc 文档,因为 Markdown 的支持和用法可能会有所不同。
内联样式
文本可以是粗体,斜体,或删除线。
你可以 链接到另一个页面。
你可以使用反引号高亮 内联代码
。
图片
Starlight 中的图片使用 Astro 的内置优化资源支持。
Markdown 和 MDX 支持用于显示图片的 Markdown 语法,其中包括屏幕阅读器和辅助技术的 alt-text。
对于在项目中本地存储的图片,也支持图片的相对路径。
标题
你可以使用标题来组织内容。Markdown 中的标题由行首的 #
数量来表示。
如何在 Starlight 中组织页面内容
Starlight 配置为自动使用页面标题作为一级标题,并将在每个页面的目录中包含一个“概述”标题。我们建议每个页面都从常规段落文本内容开始,并从 <h2>
开始使用页面标题:
自动生成标题锚点链接
使用 Markdown 中的标题将自动为你提供锚点链接,以便你可以直接链接到页面的某些部分:
二级标题 (<h2>
) 和 三级标题 (<h3>
) 将自动出现在页面目录中。
在 Astro 文档中了解 Astro 是如何处理标题 id
的。
旁白
旁白(也称为“警告”或“标注”)对于在页面的主要内容旁边显示辅助信息很有用。
Starlight 提供了一个自定义的 Markdown 语法来渲染旁白。旁白块使用一对三个冒号 :::
来包裹你的内容,并且可以是 note
,tip
,caution
或 danger
类型。
你可以在旁白中嵌套任何其他 Markdown 内容类型,但旁白最适合用于简短而简洁的内容块。
Note 旁白
自定义旁白标题
你可以在旁白类型后面的方括号中指定旁白的自定义标题,例如 :::tip[你知道吗?]
。
更多旁白类型
Caution 和 danger 旁白有助于吸引用户注意可能绊倒他们的细节。 如果你发现自己经常使用这些,这也可能表明你正在记录的内容可以从重新设计中受益。
块引用
这是块引用,通常在引用其他人或文档时使用。
块引用以每行开头的
>
表示。
代码块
代码块由三个反引号 ```
开始和结束。你可以在开头的反引号后指定代码块的编程语言。
其它通用 Markdown 语法
Starlight 支持所有其他 Markdown 语法,例如列表和表格。 请参阅 Markdown 指南的 Markdown 速查表 以快速了解所有 Markdown 语法元素。
高级 Markdown 和 MDX 配置
Starlight 使用 Astro 的 Markdown 和 MDX 渲染器,该渲染器构建在 remark 和 rehype 之上。 你可以通过在 Astro 配置文件中添加 remarkPlugins
或 rehypePlugins
来添加对自定义语法和行为的支持。 请参阅 Astro 文档中的 “配置 Markdown 和 MDX” 以了解更多信息。