跳至主要内容

创建可重用的内容

您可以创建可在多个内容文件中引用的可重用内容。

本文内容

关于可重用内容

可重用内容是长段可重用的文本,例如段落或步骤列表,可在多个内容文件中引用。

我们对可重用内容使用 Markdown(而非 YAML)。Markdown 使我们的本地化流水线能够将字符串拆分为更小的可翻译片段,从而降低翻译错误并在源英文内容变化时减少翻译工作量。

每个可重用内容都有自己独立的 Markdown 文件。

每个 Markdown 文件的路径和文件名决定其在数据对象中的路径。例如,名为 /data/reusables/foo/bar.md 的文件将在页面中通过 {% data reusables.foo.bar %} 访问。

可重用文件通常按任务划分到不同目录。例如,如果您要为 GitHub 通知相关的文章创建可重用字符串,可将其放在目录 data/reusables/notifications/ 中,文件名为 data/reusables/notifications/YOUR-REUSABLE-NAME.md。在源码中添加的内容引用应为 {% data reusables.notifications.YOUR-REUSABLE-NAME %}

对可重用内容应用版本控制

可重用内容可以包含 Liquid 条件语句,以根据当前查看的版本有条件地渲染内容。

关于变量

变量是短字符串的可重用文本。

我们对变量使用 YAML 文件。

每个 YAML 文件的路径、文件名以及其中的键决定其在数据对象中的路径。

例如,该 YAML 文件 data/variables/foo/bar.yml 包含两个变量

# the YAML file can contain multiple short strings in one file
meaning_of_life: 42

# the strings can also be nested if needed
nested:
  values:
    too: Yes!

这些值可通过 {% data foo.bar.meaning_of_life %}{% data foo.bar.nested.values.too %} 访问。

© . This site is unofficial and not affiliated with GitHub, Inc.