Skip to main content

创建可重用内容

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

“参与 GitHub Docs”部分中的文章指的是文档本身,是 GitHub 员工和开放源代码参与者的资源。

关于可重用内容

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

我们对可重用内容使用 Markdown(而不是 YAML)。 通过 Markdown,我们的本地化管道可以将字符串拆分为较小的可翻译段,从而减少翻译错误并减少源英语内容更改时的变动。

每个可重用内容都位于自己的 Markdown 文件中。

每个 Markdown 文件的路径和文件名决定了它将在数据对象中的路径是怎样的。 例如,名为 /data/reusables/foo/bar.md 的文件将在页面中以 {% data reusables.foo.bar %} 形式供用户访问。

可重用文件通常按任务划分到目录中。 例如,如果要为有关 GitHub 通知的文章创建可重用字符串,可将其添加到名为 data/reusables/notifications/YOUR-REUSABLE-NAME.md 的文件中的 data/reusables/notifications/ 目录中。 要添加到源的内容引用将类似于 {% 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 %} 进行访问。