跳至主要内容

创建可复用内容

您可以创建可复用内容,这些内容可以在多个内容文件中引用。

关于可复用内容

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

我们使用 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 %} 访问这些值。