summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSarah Rainsberger2023-06-05 10:04:57 -0300
committerGitHub2023-06-05 10:04:57 -0300
commit4fb4187855e93864536d07fe52584ba19d9a7daa (patch)
treecc7de6ba7c76b359b43f3fda1e1f351bba40fb34
parent0ffc288c551ec181f92002dccdc0d8e2438991bd (diff)
parentc6c1a289d077161b2929d6fddd11504898bd1415 (diff)
downloadIT.starlight-4fb4187855e93864536d07fe52584ba19d9a7daa.tar.gz
IT.starlight-4fb4187855e93864536d07fe52584ba19d9a7daa.tar.bz2
IT.starlight-4fb4187855e93864536d07fe52584ba19d9a7daa.zip
Merge pull request #140 from morinokami/i18n-ja-getting-started-1
-rw-r--r--docs/src/content/docs/ja/getting-started.mdx27
1 files changed, 21 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/)