再利用可能なコンテンツの作成

Reusables について

Reusables とは、複数のコンテンツ ファイルで参照できる、段落や手続き型リストなど、再利用可能なテキストからなる長い文字列です。

Reusables には Markdown が (YAML の代わりに) 使われています。 Markdown を使うと、ローカライズ パイプラインで文字列を小さな翻訳可能なセグメントに分割できるため、翻訳エラーが少なくなり、ソースの英語コンテンツが変更された場合でもチャーンが少なくなります。

各 Reusable は 個別の 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 %} のようになります。

Reusables にバージョン管理を適用する

Reusables には、表示されている現在のバージョンに応じてコンテンツを条件付きでレンダリングするための Liquid 条件を含めることができます。

変数について

変数は、再利用可能なテキストの短い文字列です。

変数には YAML ファイルを使います。

各 YAML ファイル内の パス、 ファイル名、 キー によって、データ オブジェクト内のパスが決まります。

たとえば、この YAML ファイル data/variables/foo/bar.yml には次の 2 つの変数が含まれています。

# 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 %} としてアクセスできます。