跳至主要内容

创建可重用内容

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

关于可重用内容

可重用内容是可重用文本的长字符串,例如段落或程序列表,可以在多个内容文件中引用。

我们对可重用内容使用 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 %} 访问。