Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

ファイルの規則

最終更新 Markdown で表示Agent セットアップ

ドキュメントには、ファイルに関するいくつかの規則があります。

命名

新しいファイルを作るときは、次の命名規則に従ってください。

ファイル名は次を満たします。

  • ファイルの目的が分かる名前にする
  • 小文字にする
  • 単語の間はハイフンにする
使えるファイル名txt
/src/content/docs/fundamentals/concepts/what-is-cloudflare.mdx
/src/assets/images/api-shield/api-shield-call-sequence.png
使えないファイル名txt
/src/content/docs/fundamentals/concepts/What is Cloudflare.mdx
/src/content/docs/fundamentals/concepts/What-is-Cloudflare.mdx
/src/assets/images/api-shield/API_Image_1.png

これらの規則は、読みやすさ、SEO、GitHub Actions が壊れないために重要です。

フォルダー

各フォルダーには index.mdx という名前のファイルが必要です。

/src/content/docs/fundamentals/concepts/index.mdx

/src/content/docs/fundamentals/concepts/index.mdx の内容は、https://developers.cloudflare.com/fundamentals/concepts/ で描画されます。

コンテンツファイル

通常のコンテンツファイルは /src/content/docs/{product_folder}/ ディレクトリに追加します。

/src/content/docs/fundamentals/concepts/what-is-cloudflare.mdx

画像ファイル

画像ファイルは /src/assets/images/{product_folder}/ ディレクトリに追加します。

/src/assets/images/api-shield/api-shield-call-sequence.png

役に立ちましたか?