summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShinya Fujino2023-06-21 18:24:51 +0900
committerGitHub2023-06-21 11:24:51 +0200
commit93f2717a026c91b091fc1a4f081a7a8870c16755 (patch)
tree7e5ae22f55c7f327cd9c63f9e041b477f8007c96
parent6219d8791a24ec928ca9fc8c0bdee462efb4221c (diff)
downloadIT.starlight-93f2717a026c91b091fc1a4f081a7a8870c16755.tar.gz
IT.starlight-93f2717a026c91b091fc1a4f081a7a8870c16755.tar.bz2
IT.starlight-93f2717a026c91b091fc1a4f081a7a8870c16755.zip
i18n(ja): Update configuration.md (#236)
-rw-r--r--docs/src/content/docs/ja/reference/configuration.md44
1 files changed, 18 insertions, 26 deletions
diff --git a/docs/src/content/docs/ja/reference/configuration.md b/docs/src/content/docs/ja/reference/configuration.md
index 7f807474..2624045f 100644
--- a/docs/src/content/docs/ja/reference/configuration.md
+++ b/docs/src/content/docs/ja/reference/configuration.md
@@ -82,17 +82,23 @@ starlight({
### `sidebar`
-**type:** [`SidebarGroup[]`](#sidebargroup)
+**type:** [`SidebarItem[]`](#sidebaritem)
サイトのサイドバーのナビゲーション項目を設定します。
-サイドバーはグループごとに`label`をもつ配列で、`items`配列または`autogenerate`設定オブジェクトのいずれかを含みます。
+サイドバーはリンクとリンクのグループの配列です。各項目は、`label`と以下のプロパティのいずれかが必要です。
-リンクとサブグループを含む配列である`items`により、グループの内容を手動で設定できます。また、`autogenerate`を使用して、ドキュメントの特定のディレクトリからグループの内容を自動的に生成することも可能です。
+- `link` — 特定のURL、たとえば`'/home'`や`'https://example.com'`などへの単一のリンク。
+
+- `items` — サイドバーの複数のリンクとサブグループを含む配列。
+
+- `autogenerate` — リンクのグループを自動的に生成するために、ドキュメントのディレクトリを指定するオブジェクト。
```js
starlight({
sidebar: [
+ // 「ホーム」というラベルのついた単一のリンク。
+ { label: 'ホーム', link: '/' },
// 2つのリンクを含む、「ここから始める」というラベルのついたグループ。
{
label: 'ここから始める',
@@ -101,7 +107,7 @@ starlight({
{ label: '次のステップ', link: '/next-steps' },
],
},
- // 参照先のディレクトリのすべてのページにリンクするグループ。
+ // referenceディレクトリのすべてのページにリンクするグループ。
{
label: 'リファレンス',
autogenerate: { directory: 'reference' },
@@ -140,31 +146,17 @@ sidebar: [
];
```
-#### `SidebarGroup`
-
-```ts
-type SidebarGroup =
- | {
- label: string;
- translations?: Record<string, string>;
- items: Array<LinkItem | SidebarGroup>;
- }
- | {
- label: string;
- translations?: Record<string, string>;
- autogenerate: {
- directory: string;
- };
- };
-```
-
-#### `LinkItem`
+#### `SidebarItem`
```ts
-interface LinkItem {
+type SidebarItem = {
label: string;
- link: string;
-}
+ translations?: Record<string, string>;
+} & (
+ | { link: string }
+ | { items: SidebarItem[] }
+ | { autogenerate: { directory: string } }
+);
```
### `locales`