From c0746cf4b283efad7492948291c5e916b8ebd41f Mon Sep 17 00:00:00 2001 From: KatakuraNatsumi Date: Tue, 3 Nov 2020 19:36:13 +0900 Subject: [PATCH 1/2] Translate: Documentation Style Guide --- src/guide/contributing/doc-style-guide.md | 74 +++++++++++------------ 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/src/guide/contributing/doc-style-guide.md b/src/guide/contributing/doc-style-guide.md index a465d866..99409ef4 100644 --- a/src/guide/contributing/doc-style-guide.md +++ b/src/guide/contributing/doc-style-guide.md @@ -1,59 +1,59 @@ -# Documentation Style Guide +# ドキュメントスタイルガイド -This guide will provide an overview of different design elements that are available for your use in creating documentation. +このガイドでは、ドキュメントの作成に使用できるさまざまな設計要素の概要を説明します。 -## Alerts +## アラート -VuePress provides a custom container plugin to create alert boxes. There are four types: +VuePress は、アラートボックスを作成するためのカスタムコンテナプラグインを提供します。 4つのタイプがあります: -- **Info**: Provide information that is neutral -- **Tip**: Provide information that is positive and encouraged -- **Warning**: Provide information that users should be aware of as there is a low to moderate -- **Danger**: Provide information that is negative and has a high risk to the user +- **情報**: 中立的な情報を提供する +- **ヒント**: ポジティブで奨励する情報を提供する +- **警告**: 低から中程度、ユーザが知っておくべき情報を提供する +- **危険**: ネガティブで、ユーザにリスクの高い情報を提供する -**Markdown Examples** +**マークダウンの例** ``` -::: info -You can find more information at this site. +::: 情報 +あなたはこのサイトでより多くの情報を見つけることができます。 ::: -::: tip -This is a great tip to remember! +::: ヒント +これは覚えておくべき素晴らしいヒントです！ ::: -::: warning -This is something to be cautious of. +::: 警告 +これは注意が必要なことです。 ::: -::: danger DANGER -This is something we do not recommend. Use at your own risk. +::: 危険 +これはお勧めしません。自己責任で使用してください。 ::: ``` -**Rendered Markdown** +**レンダリングされたマークダウン** -::: info -You can find more information at this site. +::: 情報 +あなたはこのサイトでより多くの情報を見つけることができます。 ::: -::: tip -This is a great tip to remember! +::: ヒント +これは覚えておくべき素晴らしいヒントです! ::: -::: warning -This is something to be cautious of. +::: 警告 +これは注意が必要なことです。 ::: -::: danger DANGER -This is something we do not recommend. Use at your own risk. +::: 危険 +これはお勧めしません。自己責任で使用してください。 ::: -## Code Blocks +## コードブロック -VuePress uses Prism to provide language syntax highlighting by appending the language to the beginning backticks of a code block: +VuePress は、Prism を使用して、コードブロックの最初のバッククォートに言語を追加することにより、言語構文の強調表示を提供します: -**Markdown Example** +**マークダウンの例** ```` ```js @@ -63,20 +63,20 @@ export default { ``` ```` -**Rendered Output** +**レンダリングされた出力** ```js export default { name: 'MyComponent' } ``` -### Line Highlighting +### 行の強調表示 -To add line highlighting to your code blocks, you need to append the line number in curly braces. +コードブロックに行の強調表示を追加するには、中括弧で行番号を追加する必要があります。 -#### Single Line +#### 一行 -**Markdown Example** +**マークダウンの例** ```` ```js{2} @@ -90,7 +90,7 @@ export default { ``` ```` -**Rendered Markdown** +**レンダリングされたマークダウン** ```js{2} export default { @@ -102,7 +102,7 @@ export default { } ``` -#### Group of Lines +#### 行のグループ ```` ```js{4-5} @@ -126,7 +126,7 @@ export default { } ``` -#### Multiple Sections +#### 複数のセクション ```` ```js{2,4-5} From 205a9950822f7ca9afd147448ba18506c7426724 Mon Sep 17 00:00:00 2001 From: KatakuraNatsumi Date: Tue, 3 Nov 2020 21:27:09 +0900 Subject: [PATCH 2/2] Revert translation due to VuePress notation --- src/guide/contributing/doc-style-guide.md | 24 +++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/guide/contributing/doc-style-guide.md b/src/guide/contributing/doc-style-guide.md index 99409ef4..37fe3482 100644 --- a/src/guide/contributing/doc-style-guide.md +++ b/src/guide/contributing/doc-style-guide.md @@ -6,46 +6,46 @@ VuePress は、アラートボックスを作成するためのカスタムコンテナプラグインを提供します。 4つのタイプがあります: -- **情報**: 中立的な情報を提供する -- **ヒント**: ポジティブで奨励する情報を提供する -- **警告**: 低から中程度、ユーザが知っておくべき情報を提供する -- **危険**: ネガティブで、ユーザにリスクの高い情報を提供する +- **Info**: 中立的な情報を提供する +- **Tip**: ポジティブで奨励する情報を提供する +- **Warning**: 低から中程度、ユーザが知っておくべき情報を提供する +- **Danger**: ネガティブで、ユーザにリスクの高い情報を提供する **マークダウンの例** ``` -::: 情報 +::: info あなたはこのサイトでより多くの情報を見つけることができます。 ::: -::: ヒント +::: tip これは覚えておくべき素晴らしいヒントです！ ::: -::: 警告 +::: warning これは注意が必要なことです。 ::: -::: 危険 +::: danger DANGER これはお勧めしません。自己責任で使用してください。 ::: ``` **レンダリングされたマークダウン** -::: 情報 +::: info あなたはこのサイトでより多くの情報を見つけることができます。 ::: -::: ヒント +::: tip これは覚えておくべき素晴らしいヒントです! ::: -::: 警告 +::: warning これは注意が必要なことです。 ::: -::: 危険 +::: danger DANGER これはお勧めしません。自己責任で使用してください。 :::