コンテンツにスキップ

共有コンテンツ試験環境

このセクションは、このリポジトリから提供される共有コンテンツを、BeeWareドキュメントの他の部分で使用するために検証する目的で含まれています。「共有コンテンツ」とは、複数の他のリポジトリに共通するドキュメントまたはドキュメントのセクションを指します。これらは、それらのリポジトリ全体に含めるためにここに保存されています。これは、更新が必要な場合に単一のソースが存在し、その変更が共有コンテンツを使用するすべてのリポジトリに反映されることを意味します。

既存のコンテンツを更新する場合、以下の手順は不要です。テストサイトをビルドするだけで、更新内容が反映された状態を確認できます。

shared-contentディレクトリ内に新しい共有ドキュメントファイルを作成する場合で、そのファイルをhow-toディレクトリに含める意図がない場合は、以下の手順を完了してください:

  1. 新しいコンテンツファイルと同じファイル名で、末尾に「_include」を付加したファイルをcontent_test_bed内に作成してください。
    • style_guide.md の場合、style_guide_include.md を追加します。
  2. スニペット構文を使用し、ファイル名をfilename_include.mdに追加します。コンテンツを含めるためのスニペット構文は-8<- "filename.md"です。
    • style_guide.md の場合、-8<- "style_guide.md"style_guide_include.md に追加します。
  3. Shared content test bed セクション内の /docs/SUMMARY.md を更新し、新しい _include ファイルとパスを含めるようにしてください。そのセクション内の他の項目と同じインデントレベルで記述してください。
    • style_guide_include.md の場合、- [Style guide](content_test_bed/style_guide_include.md) を追加します。

これらの手順が完了したら、テストサイトを構築し、新しくレンダリングされたドキュメントを確認できます。