-
-
Notifications
You must be signed in to change notification settings - Fork 570
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
Changes from 19 commits
6d0af90
446c0ec
bf117e3
b29232c
ed96c60
0332511
d2cf68c
c16fc13
967f888
c0f3324
13c0543
11b70ba
b0fba94
5e6feb3
2635a22
60ff376
ae65337
066570b
46b0770
956f898
3523dfe
2f02541
6931576
f65d15d
1fa59c5
402ca64
ed487ad
3b01094
8a901f1
64437b0
9370e1e
b715402
8ccf870
51d8307
cffe502
dcee32e
7441a3f
b64b7bb
44b18c1
4eb4570
0321c2e
ae4f37c
3beede1
7f97fa6
e3828a5
c1addb0
433c508
2f62021
0a205da
1403586
a62ffaf
a5e6cc9
d768fd1
61f0c70
187a9e3
b66afbd
1646d9d
869ab03
d23ee5b
13f67b9
18d9278
5a57753
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
--- | ||
title: アサイド | ||
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
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd prefer "型" for this one! fixed: |
||
**デフォルト:** `'note'` | ||
|
||
表示するアサイドのタイプ: | ||
|
||
- `note`アサイド(デフォルト)は青色で、情報アイコンを表示します。 | ||
- `tip`アサイドは紫色で、ロケットアイコンを表示します。 | ||
- `caution`アサイドは黄色で、三角形の警告アイコンを表示します。 | ||
- `danger`アサイドは赤色で、八角形の警告アイコンを表示します。 | ||
|
||
### `title` | ||
|
||
**型:** `string` | ||
|
||
表示するアサイドのタイトル。 | ||
`title`が設定されていない場合、現在のアサイド`type`のデフォルトタイトルが使用されます。 |
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" /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can safely translate the "New" text in this preview. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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" /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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" /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here for this example There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And also for this last example. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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'` | ||
|
||
表示するバッジのサイズを定義します。 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:)