summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSarah Rainsberger2023-06-05 10:11:00 -0300
committerGitHub2023-06-05 10:11:00 -0300
commit2516d1f9b647f51f3e03a1efa168b46926f57ee8 (patch)
treee5687850e423eda2e6a7d66d00aa8d29e6c1eaae
parent4fb4187855e93864536d07fe52584ba19d9a7daa (diff)
parentef4f6dcd1e2637a0519ace1252fc75cfe5a1a565 (diff)
downloadIT.starlight-2516d1f9b647f51f3e03a1efa168b46926f57ee8.tar.gz
IT.starlight-2516d1f9b647f51f3e03a1efa168b46926f57ee8.tar.bz2
IT.starlight-2516d1f9b647f51f3e03a1efa168b46926f57ee8.zip
Merge pull request #141 from morinokami/i18n-ja-project-structure-0
-rw-r--r--docs/src/content/docs/ja/guides/project-structure.mdx48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/src/content/docs/ja/guides/project-structure.mdx b/docs/src/content/docs/ja/guides/project-structure.mdx
new file mode 100644
index 00000000..78fc6778
--- /dev/null
+++ b/docs/src/content/docs/ja/guides/project-structure.mdx
@@ -0,0 +1,48 @@
+---
+title: ディレクトリ構成
+description: Starlightプロジェクトでファイルをどのように配置するかについて学びます。
+---
+
+このガイドでは、Starlightプロジェクトの構成と、プロジェクト内のさまざまなファイルの役割について説明します。
+
+Starlightプロジェクトは、基本的に他のAstroプロジェクトと同じファイル・ディレクトリ構成に従います。詳細については、[Astroのディレクトリ構成のドキュメント](https://docs.astro.build/ja/core-concepts/project-structure/)を参照してください。
+
+## ファイルとディレクトリ
+
+- `astro.config.mjs` — Astroの設定ファイルで、ここにStarlightのインテグレーションや設定を記述します。
+- `src/content/config.ts` — コンテンツコレクションの設定ファイルで、Starlightのフロントマタースキーマをプロジェクトに追加します。
+- `src/content/docs/` — コンテンツのファイルが置かれます。Starlightは、このディレクトリ内の各`.md`、`.mdx`、`.mdoc`ファイルを、サイトのページへと変換します。
+- `src/content/i18n/`(任意) — [国際化](/ja/guides/i18n/)をサポートするための翻訳データが置かれます。
+- `src/` — プロジェクトの他のソースコードやファイル(コンポーネント、スタイル、画像など)が置かれます。
+- `public/` — Astroによって処理されない静的アセット(フォント、ファビコン、PDFなど)が置かれます。
+
+## プロジェクトの中身の例
+
+Starlightプロジェクトのディレクトリは、次のようになります。
+
+import FileTree from '../../../../components/file-tree.astro';
+
+<FileTree>
+
+- public/
+ - favicon.svg
+- src/
+ - assets/
+ - logo.svg
+ - screenshot.jpg
+ - components/
+ - CustomButton.astro
+ - InteractiveWidget.jsx
+ - content/
+ - docs/
+ - guides/
+ - 01-getting-started.md
+ - 02-advanced.md
+ - index.mdx
+ - config.ts
+ - env.d.ts
+- astro.config.mjs
+- package.json
+- tsconfig.json
+
+</FileTree>