Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

i18n(ja): translated components section + alpha #2384

Merged
merged 62 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
6d0af90
chore: support sidebar `components` for ja
Kenzo-Wada Sep 20, 2024
446c0ec
feat: add `using-components.mdx` for ja
Kenzo-Wada Sep 20, 2024
bf117e3
feat: add `icons.mdx` for ja
Kenzo-Wada Sep 20, 2024
b29232c
feat: add `cards.mdx` for ja
Kenzo-Wada Sep 20, 2024
ed96c60
feat: add `link-cards.mdx` for ja
Kenzo-Wada Sep 20, 2024
0332511
feat: add `card-grids.mdx` for ja
Kenzo-Wada Sep 20, 2024
d2cf68c
feat: add markdoc for ja
Kenzo-Wada Sep 20, 2024
c16fc13
feat: add `asides.mdx` for ja
Kenzo-Wada Sep 20, 2024
967f888
feat: add `badges.mdx` for ja
Kenzo-Wada Sep 20, 2024
c0f3324
feat: add `code.mdx` for ja
Kenzo-Wada Sep 20, 2024
13c0543
feat: add `file-tree.mdx` for ja
Kenzo-Wada Sep 20, 2024
11b70ba
feat: add `icons.mdx` for ja
Kenzo-Wada Sep 20, 2024
b0fba94
feat: add `link-buttons.mdx` for ja
Kenzo-Wada Sep 20, 2024
5e6feb3
feat: add `steps.mdx` for ja
Kenzo-Wada Sep 20, 2024
2635a22
feat: add `tabs.mdx` for ja
Kenzo-Wada Sep 20, 2024
60ff376
fix: update link to `/ja/~~`
Kenzo-Wada Sep 20, 2024
ae65337
fix: update link to `/ja/~~`
Kenzo-Wada Sep 20, 2024
066570b
fix: update link to `/ja/~~`
Kenzo-Wada Sep 20, 2024
46b0770
Merge branch 'main' into chore/i18n-ja-components
Kenzo-Wada Sep 20, 2024
956f898
Update docs/src/content/docs/ja/components/asides.mdx
Kenzo-Wada Sep 24, 2024
3523dfe
Update docs/src/content/docs/ja/components/asides.mdx
Kenzo-Wada Sep 24, 2024
2f02541
Update docs/src/content/docs/ja/components/asides.mdx
Kenzo-Wada Sep 24, 2024
6931576
Update docs/src/content/docs/ja/components/asides.mdx
Kenzo-Wada Sep 24, 2024
f65d15d
Update docs/src/content/docs/ja/components/badges.mdx
Kenzo-Wada Sep 24, 2024
1fa59c5
Update docs/src/content/docs/ja/components/link-cards.mdx
Kenzo-Wada Sep 24, 2024
402ca64
Update docs/src/content/docs/ja/guides/authoring-content.mdx
Kenzo-Wada Sep 24, 2024
ed487ad
Update docs/src/content/docs/ja/guides/authoring-content.mdx
Kenzo-Wada Sep 24, 2024
3b01094
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
8a901f1
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
64437b0
Update docs/src/content/docs/ja/components/card-grids.mdx
Kenzo-Wada Sep 24, 2024
9370e1e
Update docs/src/content/docs/ja/components/card-grids.mdx
Kenzo-Wada Sep 24, 2024
b715402
Update docs/src/content/docs/ja/components/link-buttons.mdx
Kenzo-Wada Sep 24, 2024
8ccf870
Update docs/src/content/docs/ja/components/link-buttons.mdx
Kenzo-Wada Sep 24, 2024
51d8307
Update docs/src/content/docs/ja/components/link-buttons.mdx
Kenzo-Wada Sep 24, 2024
cffe502
Update docs/src/content/docs/ja/components/link-buttons.mdx
Kenzo-Wada Sep 24, 2024
dcee32e
Update docs/src/content/docs/ja/components/link-cards.mdx
Kenzo-Wada Sep 24, 2024
7441a3f
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
b64b7bb
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
44b18c1
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
4eb4570
Update docs/src/content/docs/ja/components/using-components.mdx
Kenzo-Wada Sep 24, 2024
0321c2e
chore: rename Aside
Kenzo-Wada Sep 24, 2024
ae4f37c
chore: translate preview of `badge`
Kenzo-Wada Sep 24, 2024
3beede1
chore: translate usage of `badge`
Kenzo-Wada Sep 24, 2024
7f97fa6
chore: translate size of `badge`
Kenzo-Wada Sep 24, 2024
e3828a5
chore: translate customize of `badge`
Kenzo-Wada Sep 24, 2024
c1addb0
chore: use the same translation for `type`
Kenzo-Wada Sep 24, 2024
433c508
chore: translate example of `code`
Kenzo-Wada Sep 24, 2024
2f62021
chore: translate `important`
Kenzo-Wada Sep 24, 2024
0a205da
chore: translate `important` for example
Kenzo-Wada Sep 24, 2024
1403586
chore: translate label for `icons`
Kenzo-Wada Sep 24, 2024
a62ffaf
chore: translate preview of `tabs`
Kenzo-Wada Sep 24, 2024
a5e6cc9
chore: translate usage of `tabs`
Kenzo-Wada Sep 24, 2024
d768fd1
chore: translate syncKey of `tabs`
Kenzo-Wada Sep 24, 2024
61f0c70
chore: translate icons of `tabs`
Kenzo-Wada Sep 24, 2024
187a9e3
chore: add link for icons
Kenzo-Wada Sep 24, 2024
b66afbd
chore: translate title
Kenzo-Wada Sep 24, 2024
1646d9d
chore: translate sample of `code`
Kenzo-Wada Sep 24, 2024
869ab03
Merge branch 'main' into chore/i18n-ja-components
Kenzo-Wada Sep 24, 2024
d23ee5b
Merge branch 'main' into chore/i18n-ja-components
Kenzo-Wada Sep 25, 2024
13f67b9
Merge branch 'main' into chore/i18n-ja-components
Kenzo-Wada Sep 25, 2024
18d9278
Add missing translation
HiDeoo Sep 26, 2024
5a57753
Merge branch 'main' into chore/i18n-ja-components
HiDeoo Sep 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ export default defineConfig({
translations: {
fr: 'Composants',
ko: '컴포넌트',
ja: 'コンポーネント',
},
autogenerate: { directory: 'components' },
},
Expand Down
154 changes: 154 additions & 0 deletions docs/src/content/docs/ja/components/asides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
title: アサイド
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting that in the previous version of the documentation, we were using "補足情報".

Is the change expected or one is better than the other? Let me know what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0321c2e

This was the part I was just struggling with when I implemented it...

I initially named it “アサイド” because I thought it would be better to treat it like a proper noun, but if you had documented it that way before, I think I'll use that name for now! sounds nice:)

description: Starlightでアサイドを使用して、ページのメインコンテンツの横に補足情報を表示する方法を学びます。
---

import { Aside } from '@astrojs/starlight/components';

ページのメインコンテンツの横に補足情報を表示するには、`<Aside>`コンポーネントを使用します。

import Preview from '~/components/component-preview.astro';

<Preview>
<Aside slot="preview">
`<Aside>`に重要ではない補足情報を含めます。
</Aside>
</Preview>

## インポート

```tsx
import { Aside } from '@astrojs/starlight/components';
```

## 使用方法

`<Aside>`コンポーネントを使用してアサイド(「アドモニション」や「コールアウト」とも呼ばれる)を表示します。
Kenzo-Wada marked this conversation as resolved.
Show resolved Hide resolved
`<Aside>`にはオプションの[`type`](#type)属性があり、これによってアサイドの色、アイコン、およびデフォルトのタイトルが制御されます。

<Preview>

````mdx
import { Aside } from '@astrojs/starlight/components';

<Aside>アサイドのコンテンツ。</Aside>

<Aside type="caution">注意が必要なコンテンツ。</Aside>

<Aside type="tip">
アサイドには他のコンテンツも対応しています。
Kenzo-Wada marked this conversation as resolved.
Show resolved Hide resolved

```js
// たとえば、コードスニペットなど。
```

</Aside>

<Aside type="danger">パスワードを誰にも教えないでください。</Aside>
````

<Fragment slot="markdoc">

````markdoc
{% aside %}
アサイドのコンテンツ。
{% /aside %}

{% aside type="caution" %}
注意が必要なコンテンツ。
{% /aside %}

{% aside type="tip" %}
アサイドには他のコンテンツも対応しています。

```js
// たとえば、コードスニペットなど。
```

{% /aside %}
Kenzo-Wada marked this conversation as resolved.
Show resolved Hide resolved

{% aside type="danger" %}
パスワードを誰にも教えないでください。
{% /aside %}
````

</Fragment>

<Fragment slot="preview">

<Aside>アサイドのコンテンツ。</Aside>

<Aside type="caution">注意が必要なコンテンツ。</Aside>

<Aside type="tip">

アサイドには他のコンテンツも対応しています。

```js
// たとえば、コードスニペットなど。
```
</Aside>

<Aside type="danger">パスワードを誰にも教えないでください。</Aside>

</Fragment>

</Preview>

Starlightは、`<Aside>`コンポーネントの代替として、MarkdownとMDXでアサイドをレンダリングするためのカスタム構文も提供しています。
カスタム構文の詳細については、["MarkdownでのContent作成"](/ja/guides/authoring-content/#補足情報)ガイドを参照してください。

### カスタムタイトルの使用

[`title`](#title)属性を使用して、デフォルトのアサイドタイトルを上書きできます。

<Preview>

```mdx 'title="注意してください!"'
import { Aside } from '@astrojs/starlight/components';

<Aside type="caution" title="注意してください!">
カスタムタイトル*付きの*警告アサイド。
</Aside>
```

<Fragment slot="markdoc">

```markdoc 'title="注意してください!"'
{% aside type="caution" title="注意してください!" %}
カスタムタイトル*付きの*警告アサイド。
{% /aside %}
```

</Fragment>

<Aside slot="preview" type="caution" title="注意してください!">
カスタムタイトル*付きの*警告アサイド。
</Aside>

</Preview>

## `<Aside>` プロパティ

**実装:** [`Aside.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Aside.astro)

`<Aside>`コンポーネントは以下のプロパティを受け入れます:

### `type`

**型:** `'note' | 'tip' | 'caution' | 'danger'`
Kenzo-Wada marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like in other pages, "タイプ" is also used for the "type" and not "型". We should use the same wording for consistency but I don't know which one is best in this case? Should we update this one and the one below or change all the others instances?

Let me know what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer "型" for this one!

fixed:
c1addb0

**デフォルト:** `'note'`

表示するアサイドのタイプ:

- `note`アサイド(デフォルト)は青色で、情報アイコンを表示します。
- `tip`アサイドは紫色で、ロケットアイコンを表示します。
- `caution`アサイドは黄色で、三角形の警告アイコンを表示します。
- `danger`アサイドは赤色で、八角形の警告アイコンを表示します。

### `title`

**型:** `string`

表示するアサイドのタイトル。
`title`が設定されていない場合、現在のアサイド`type`のデフォルトタイトルが使用されます。
150 changes: 150 additions & 0 deletions docs/src/content/docs/ja/components/badges.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
title: バッジ
description: Starlightでバッジを使用して追加の情報を表示する方法を学びましょう。
---

import { Badge } from '@astrojs/starlight/components';

ステータスやカテゴリーのような小さな情報を表示するには、`<Badge>`コンポーネントを使用します。

import Preview from '~/components/component-preview.astro';

<Preview>

<Badge slot="preview" text="New" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can safely translate the "New" text in this preview.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ae4f37c

fixed here!


</Preview>

## インポート

```tsx
import { Badge } from '@astrojs/starlight/components';
```

## 使用方法

バッジを表示するには、`<Badge>`コンポーネントを使用し、表示したい内容を[`text`](#text)属性に渡します。

デフォルトでは、バッジはサイトのテーマのアクセントカラーを使用します。
組み込みのバッジカラーを使用するには、[`variant`](#variant)属性をサポートされている値のいずれかに設定します。

<Preview>

```mdx
import { Badge } from '@astrojs/starlight/components';

<Badge text="Note" variant="note" />
<Badge text="Success" variant="success" />
<Badge text="Tip" variant="tip" />
<Badge text="Caution" variant="caution" />
<Badge text="Danger" variant="danger" />
```

<Fragment slot="markdoc">

```markdoc
{% badge text="Note" variant="note" /%}
{% badge text="Success" variant="success" /%}
{% badge text="Tip" variant="tip" /%}
{% badge text="Caution" variant="caution" /%}
{% badge text="Danger" variant="danger" /%}
```

</Fragment>

<Fragment slot="preview">
<Badge text="Note" variant="note" />
<Badge text="Success" variant="success" />
<Badge text="Tip" variant="tip" />
<Badge text="Caution" variant="caution" />
<Badge text="Danger" variant="danger" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for this example, we can translate all the texts. Four of them could be picked from our translation file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3beede1

fixed here!

</Fragment>

</Preview>

### 異なるサイズの使用

[`size`](#size)属性を使用してバッジのテキストサイズを制御します。

<Preview>

```mdx /size="\w+"/
import { Badge } from '@astrojs/starlight/components';

<Badge text="New" size="small" />
<Badge text="New and improved" size="medium" />
<Badge text="New, improved, and bigger" size="large" />
```

<Fragment slot="markdoc">

```markdoc /size="\w+"/
{% badge text="New" size="small" /%}
{% badge text="New and improved" size="medium" /%}
{% badge text="New, improved, and bigger" size="large" /%}
```

</Fragment>

<Fragment slot="preview">
<Badge text="New" size="small" />
<Badge text="New and improved" size="medium" />
<Badge text="New, improved, and bigger" size="large" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here for this example text.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

7f97fa6

fixed here!

</Fragment>

</Preview>

### バッジのカスタマイズ

カスタムCSSを使用して、`class`や`style`などの他の`<span>`属性を使用してバッジをカスタマイズします。

<Preview>

```mdx "style={{ fontStyle: 'italic' }}"
import { Badge } from '@astrojs/starlight/components';

<Badge text="Custom" variant="success" style={{ fontStyle: 'italic' }} />
```

<Fragment slot="markdoc">

```markdoc 'style="font-style: italic;"'
{% badge text="Custom" variant="success" style="font-style: italic;" /%}
```

</Fragment>

<Badge
slot="preview"
text="Custom"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And also for this last example.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e3828a5

fixed here!

variant="success"
style={{ fontStyle: 'italic' }}
/>

</Preview>

## `<Badge>` プロパティ

**実装:** [`Badge.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Badge.astro)

`<Badge>`コンポーネントは、以下のプロパティおよびその他の[`<span>`要素の属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes)を受け付けます。
Kenzo-Wada marked this conversation as resolved.
Show resolved Hide resolved

### `text`

**必須**
**タイプ:** `string`

バッジに表示するテキスト内容。

### `variant`

**タイプ:** `'note' | 'danger' | 'success' | 'caution' | 'tip' | 'default'`
**デフォルト:** `'default'`

使用するバッジのカラーバリアント: `note` (青), `tip` (紫), `danger` (赤), `caution` (オレンジ), `success` (緑), または `default` (テーマのアクセントカラー)。

### `size`

**タイプ:** `'small' | 'medium' | 'large'`

表示するバッジのサイズを定義します。
Loading
Loading