Skip to content

Commit

Permalink
Merge branch 'main' into i18n-ja-frontmatter-10
Browse files Browse the repository at this point in the history
  • Loading branch information
HiDeoo authored Nov 4, 2024
2 parents 51fe297 + c846696 commit 528db4e
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 12 deletions.
7 changes: 3 additions & 4 deletions docs/src/content/docs/ja/reference/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@ title: アイコン
description: Starlightで利用可能なすべてのアイコンの概要。
---

Starlightには、`<Icon>`コンポーネントを使用してコンテンツに表示できる組み込みのアイコンセットが用意されています
Starlightには、`<Icon>`コンポーネントを使用してコンテンツに表示できる、組み込みのアイコンセットが用意されています

## アイコンの使用

アイコンは[`<Icon>`](/ja/components/icons/)コンポーネントを使用して表示できます。
また、[カード](/ja/components/cards/)[ヒーローアクション](/ja/reference/frontmatter/#hero)などの設定のような他のコンポーネントでもよく使用されます。
アイコンは[`<Icon>`](/ja/components/icons/)コンポーネントを使用して表示できます。また、[カード](/ja/components/cards/)[ヒーローアクション](/ja/reference/frontmatter/#hero)の設定など、他のコンポーネントでもよく使用されます。

## すべてのアイコン

利用可能なすべてのアイコンとその関連名が以下にリストされています。アイコンをクリックすると、その名前がクリップボードにコピーされます。

import IconsList from '~/components/icons-list.astro';

<IconsList />
<IconsList labels={{ copied: 'コピー完了!' }} />
28 changes: 20 additions & 8 deletions docs/src/content/docs/ja/reference/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ Starlightは、以下のpropsをカスタムコンポーネントに渡します

言語が配信されるベースパス。ルートロケールスラグの場合は`undefined`となります。

#### `siteTitle`

**Type:** `string`

このページのロケールのサイトタイトル。

#### `siteTitleHref`

**Type:** `string`

サイトタイトルの`href`属性の値。たとえば`/`など、ホームページへのリンクとなります。多言語サイトの場合、たとえば`/en/``/zh-cn/`など、現在のロケールが含まれます。

#### `slug`

**Type:** `string`
Expand Down Expand Up @@ -87,7 +99,7 @@ entry: {
}
```

このオブジェクトの構造については、[Astroのコレクションエントリー型](https://docs.astro.build/ja/reference/api-reference/#collection-entry-type)リファレンスを参照してください。
このオブジェクトの構造については、[Astroのコレクションエントリー型](https://docs.astro.build/ja/reference/modules/astro-content/#collectionentry)リファレンスを参照してください。

#### `sidebar`

Expand Down Expand Up @@ -131,12 +143,6 @@ entry: {

ページの編集設定が有効な場合、このページを編集可能なアドレスの`URL`オブジェクト。

#### `labels`

**Type:** `Record<string, string>`

現在のページのローカライズされたUI文字列を含んだオブジェクト。利用可能なすべてのキーの一覧については、[「StarlightのUIを翻訳する」](/ja/guides/i18n/#starlightのuiを翻訳する)ガイドを参照してください。

---

## コンポーネント
Expand Down Expand Up @@ -203,7 +209,7 @@ entry: {

**デフォルトコンポーネント:** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro)

すべてのページの上部に表示されるヘッダーコンポーネント。デフォルトの実装では、[`<SiteTitle />`](#sitetitle)[`<Search />`](#search)[`<SocialIcons />`](#socialicons)[`<ThemeSelect />`](#themeselect)[`<LanguageSelect />`](#languageselect)を表示します。
すべてのページの上部に表示されるヘッダーコンポーネント。デフォルトの実装では、[`<SiteTitle />`](#sitetitle-1)[`<Search />`](#search)[`<SocialIcons />`](#socialicons)[`<ThemeSelect />`](#themeselect)[`<LanguageSelect />`](#languageselect)を表示します。

#### `SiteTitle`

Expand Down Expand Up @@ -305,6 +311,12 @@ Starlightのページサイドバーは、現在のページの見出しを列

デフォルトの実装と同様に、`<h1>`要素に`id="_top"`を設定する必要があります。

#### `DraftContentNotice`

**デフォルトコンポーネント:** [`DraftContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/DraftContentNotice.astro)

現在のページがドラフトとしてマークされている場合、開発中にユーザーに表示される通知。

#### `FallbackContentNotice`

**デフォルトコンポーネント:** [`FallbackContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/FallbackContentNotice.astro)
Expand Down
10 changes: 10 additions & 0 deletions docs/src/content/docs/zh-cn/resources/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ sidebar:
title="starlight-site-graph"
description="在页面的侧边栏中添加一个交互式站点图。"
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-sidebar-topics"
title="starlight-sidebar-topics"
description="将你的文档分成不同的部分,每个部分都有自己的侧边栏。"
/>
<LinkCard
href="https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown"
title="starlight-sidebar-topics-dropdown"
description="将你的文档页面拆分为多个子页面,并使用侧边栏中的下拉菜单在它们之间切换。"
/>
</CardGrid>

### 社区主题
Expand Down

0 comments on commit 528db4e

Please sign in to comment.