summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSarah Rainsberger2023-06-05 10:29:59 -0300
committerGitHub2023-06-05 10:29:59 -0300
commit57236eb558e29e4f917273ec7f11c8b4d801b432 (patch)
tree7090cfc57548cf64993eec33a3dfd4cfb687ad2b
parent1b56f62159d46f21c1a98616226526eab010bbd6 (diff)
parent6b2a1dfd5d369fe7e423f9cd143d40a305350ef4 (diff)
downloadIT.starlight-57236eb558e29e4f917273ec7f11c8b4d801b432.tar.gz
IT.starlight-57236eb558e29e4f917273ec7f11c8b4d801b432.tar.bz2
IT.starlight-57236eb558e29e4f917273ec7f11c8b4d801b432.zip
Merge branch 'main' into i18n-ja-components-and-i18n
-rw-r--r--docs/src/content/docs/ja/getting-started.mdx27
-rw-r--r--docs/src/content/docs/ja/guides/project-structure.mdx48
-rw-r--r--docs/src/content/docs/ja/reference/configuration.md15
3 files changed, 84 insertions, 6 deletions
diff --git a/docs/src/content/docs/ja/getting-started.mdx b/docs/src/content/docs/ja/getting-started.mdx
index 0a7a6dcf..23fc7d0b 100644
--- a/docs/src/content/docs/ja/getting-started.mdx
+++ b/docs/src/content/docs/ja/getting-started.mdx
@@ -11,7 +11,9 @@ Starlightã¯ã¾ã é–‹ç™ºã®åˆæœŸæ®µéšŽã«ã‚りã¾ã™ã€‚何ã‹ä¸å…·åˆã‚’見ã
## æ–°ã—ã„プロジェクトを作æˆã™ã‚‹
-Starlightã¯ã€ã‚ªãƒ¼ãƒ«ã‚¤ãƒ³ãƒ¯ãƒ³ã®ãƒ•レームワークã§ã‚ã‚‹[Astro](https://astro.build)ã®ä¸Šã«æ§‹ç¯‰ã•れã¦ã„ã¾ã™ã€‚次ã®ã‚³ãƒžãƒ³ãƒ‰ã«ã‚ˆã‚Šã€Astro + Starlightã®æ–°ã—ã„プロジェクトを作æˆã§ãã¾ã™ã€‚
+Starlightã¯ã€[Astro](https://astro.build)ã®ä¸Šã«æ§‹ç¯‰ã•れãŸã€ãƒ•ル機能ã®ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆå‘ã‘テーマã§ã™ã€‚
+
+以下ã®ã‚³ãƒžãƒ³ãƒ‰ã«ã‚ˆã‚Šã€Astro + Starlightã®æ–°ã—ã„プロジェクトを作æˆã§ãã¾ã™ã€‚
<Tabs>
<TabItem label="npm">
@@ -40,7 +42,7 @@ yarn create astro --template starlight
</TabItem>
</Tabs>
-ã“れã«ã‚ˆã‚Šã€ã‚µã‚¤ãƒˆã«å¿…è¦ãªã™ã¹ã¦ã®ãƒ•ァイルã¨è¨­å®šãŒå«ã¾ã‚ŒãŸã€æ–°ã—ã„プロジェクトディレクトリãŒä½œæˆã•れã¾ã™ã€‚
+ã“れã«ã‚ˆã‚Šã€ã‚µã‚¤ãƒˆã«å¿…è¦ãªã™ã¹ã¦ã®ãƒ•ァイルã¨è¨­å®šãŒå«ã¾ã‚ŒãŸã€æ–°ã—ã„[プロジェクトディレクトリ](/ja/guides/project-structure/)ãŒä½œæˆã•れã¾ã™ã€‚
:::tip[試ã—ã¦ã¿ã‚ˆã†]
Starlightをブラウザã§è©¦ã™ã«ã¯ã€[StackBlitzã§ãƒ†ãƒ³ãƒ—レートを開ãã¾ã™](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)。
@@ -48,11 +50,24 @@ Starlightをブラウザã§è©¦ã™ã«ã¯ã€[StackBlitzã§ãƒ†ãƒ³ãƒ—レートを開
## Starlightã§ã‚³ãƒ³ãƒ†ãƒ³ãƒ„を作æˆã™ã‚‹
-Starlightã§ã¯ã€Markdownã¨MDXã§ã‚³ãƒ³ãƒ†ãƒ³ãƒ„を作æˆã§ãã¾ã™ã€‚
+以上ã§ã€Starlightã«æ–°ã—ã„コンテンツを追加ã—ãŸã‚Šã€æ—¢å­˜ã®ãƒ•ァイルをæŒã¡è¾¼ã‚“ã ã‚Šã™ã‚‹æº–å‚™ãŒã§ãã¾ã—ãŸï¼
+
+### ファイルフォーマット
+
+Starlightã§ã¯ã€Markdownã¨MDXã§ã‚³ãƒ³ãƒ†ãƒ³ãƒ„を作æˆã§ãã¾ã™ã€‚(Markdocã®ã‚µãƒãƒ¼ãƒˆã¯ã€å®Ÿé¨“çš„ãª[Astroã®Markdocインテグレーション](https://docs.astro.build/ja/guides/integrations-guide/markdoc/)をインストールã—ã¦è¿½åŠ ã§ãã¾ã™ã€‚)
+
+### ページã®è¿½åŠ 
+
+`src/content/docs/`ã«`.md`ã¾ãŸã¯`.mdx`ファイルを作æˆã—ã¦ã€ã‚µã‚¤ãƒˆã«æ–°ã—ã„ページを自動ã§è¿½åŠ ã§ãã¾ã™ã€‚ファイルを整ç†ã™ã‚‹ãŸã‚ã«ã‚µãƒ–フォルダを追加ã—ã€è¤‡æ•°ã®ãƒ‘スセグメントを作æˆã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚
+
+```js
+`src/content/docs/hello-world.md` -> `your-site/hello-world`
+`src/content/docs/guides/faq.md` -> `your-site/guides/faq`
+```
-`src/content/docs/`ã«`.md`ã¾ãŸã¯`.mdx`ファイルを作æˆã—ã¦ã€æ–°ã—ã„ページを追加ã—ã¾ã™ã€‚ãŸã¨ãˆã°ã€`src/content/docs/hello-world.md`ã¯ã€ã‚µã‚¤ãƒˆã®`/hello-world`ã‹ã‚‰ã‚¢ã‚¯ã‚»ã‚¹ã§ãã¾ã™ã€‚
+### 型安全ãªãƒ•ロントマター
-Starlightã®ãƒšãƒ¼ã‚¸ã¯ã€ãƒšãƒ¼ã‚¸ã®è¡¨ç¤ºæ–¹æ³•を制御ã™ã‚‹ãŸã‚ã®ã€å…±é€šã®ãƒ•ロントマタープロパティをèªè­˜ã—ã¾ã™ã€‚
+Starlightã®ãƒšãƒ¼ã‚¸ã¯ã€ãƒšãƒ¼ã‚¸ã®è¡¨ç¤ºæ–¹æ³•を制御ã™ã‚‹ãŸã‚ã®ã€ã‚«ã‚¹ã‚¿ãƒžã‚¤ã‚ºå¯èƒ½ãª[共通ã®ãƒ•ロントマタープロパティ](/ja/reference/frontmatter/)ã‚’èªè­˜ã—ã¾ã™ã€‚
```md
---
@@ -65,6 +80,6 @@ description: ã“れã¯Starlightã§ä½œæˆã•れãŸã‚µã‚¤ãƒˆã®ãƒšãƒ¼ã‚¸ã§ã™
## Starlightサイトをデプロイã™ã‚‹
-Starlightサイトã®ä½œæˆã¨ã‚«ã‚¹ã‚¿ãƒžã‚¤ã‚ºãŒå®Œäº†ã—ãŸã‚‰ã€ãŠå¥½ã¿ã®ã‚¦ã‚§ãƒ–サーãƒãƒ¼ã‚„ホスティングプラットフォームã«ãƒ‡ãƒ—ロイã§ãã¾ã™ã€‚Astroã«ã¯ã€Netlifyã€Vercelã€GitHub Pagesãªã©ã€äººæ°—ã®ãƒ›ã‚¹ãƒ†ã‚£ãƒ³ã‚°ãƒ—ラットフォームã¸ã®ã‚µãƒãƒ¼ãƒˆãŒçµ„ã¿è¾¼ã¾ã‚Œã¦ã„ã‚‹ãŸã‚ã€ç°¡å˜ãªã‚³ãƒžãƒ³ãƒ‰ã‚’ã„ãã¤ã‹å®Ÿè¡Œã™ã‚‹ã ã‘ã§ã‚¦ã‚§ãƒ–サイトをデプロイã§ãã¾ã™ã€‚
+Starlightサイトã®ä½œæˆã¨ã‚«ã‚¹ã‚¿ãƒžã‚¤ã‚ºãŒå®Œäº†ã—ãŸã‚‰ã€Netlifyã€Vercelã€GitHub Pagesã€ãã®ä»–多ãã®ãŠå¥½ã¿ã®ã‚¦ã‚§ãƒ–サーãƒãƒ¼ã‚„ホスティングプラットフォームã«ãƒ‡ãƒ—ロイã§ãã¾ã™ã€‚
[Astroサイトã®ãƒ‡ãƒ—ロイã«ã¤ã„ã¦ã¯ã€Astroã®ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’å‚ç…§ã—ã¦ãã ã•ã„。](https://docs.astro.build/ja/guides/deploy/)
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>
diff --git a/docs/src/content/docs/ja/reference/configuration.md b/docs/src/content/docs/ja/reference/configuration.md
index 65501ed9..20bf64e7 100644
--- a/docs/src/content/docs/ja/reference/configuration.md
+++ b/docs/src/content/docs/ja/reference/configuration.md
@@ -5,6 +5,21 @@ description: StarlightãŒã‚µãƒãƒ¼ãƒˆã™ã‚‹ã™ã¹ã¦ã®è¨­å®šã‚ªãƒ—ã‚·ãƒ§ãƒ³ã®æ
## `starlight`インテグレーションã®è¨­å®š
+Starlightã¯[Astro](https://astro.build)ウェブフレームワークã®ä¸Šã«æ§‹ç¯‰ã•れãŸã‚¤ãƒ³ãƒ†ã‚°ãƒ¬ãƒ¼ã‚·ãƒ§ãƒ³ã§ã™ã€‚Astroã®`astro.config.mjs`設定ファイル内ã§ãƒ—ロジェクトã®è¨­å®šã‚’ãŠã“ãªã„ã¾ã™ã€‚
+
+```js
+// astro.config.mjs
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+export default defineConfig({
+ integrations: [
+ starlight({
+ title: "ç§ã®æ¥½ã—ã„ドキュメントサイト",
+ }),
+ ],
+});
+```
+
以下ã®ã‚ªãƒ—ションを`starlight`インテグレーションã«è¨­å®šã§ãã¾ã™ã€‚
### `title`(必須)