1
- # Documentation Style Guide
1
+ # ドキュメントスタイルガイド
2
2
3
- This guide will provide an overview of different design elements that are available for your use in creating documentation.
3
+ このガイドでは、ドキュメントの作成に使用できるさまざまな設計要素の概要を説明します。
4
4
5
- ## Alerts
5
+ ## アラート
6
6
7
- VuePress provides a custom container plugin to create alert boxes. There are four types :
7
+ VuePress は、アラートボックスを作成するためのカスタムコンテナプラグインを提供します。 4つのタイプがあります :
8
8
9
- - ** Info** : Provide information that is neutral
10
- - ** Tip** : Provide information that is positive and encouraged
11
- - ** Warning** : Provide information that users should be aware of as there is a low to moderate
12
- - ** Danger** : Provide information that is negative and has a high risk to the user
9
+ - ** Info** : 中立的な情報を提供する
10
+ - ** Tip** : ポジティブで奨励する情報を提供する
11
+ - ** Warning** : 低から中程度、ユーザが知っておくべき情報を提供する
12
+ - ** Danger** : ネガティブで、ユーザにリスクの高い情報を提供する
13
13
14
- ** Markdown Examples **
14
+ ** マークダウンの例 **
15
15
16
16
```
17
17
::: info
18
- You can find more information at this site.
18
+ あなたはこのサイトでより多くの情報を見つけることができます。
19
19
:::
20
20
21
21
::: tip
22
- This is a great tip to remember!
22
+ これは覚えておくべき素晴らしいヒントです!
23
23
:::
24
24
25
25
::: warning
26
- This is something to be cautious of.
26
+ これは注意が必要なことです。
27
27
:::
28
28
29
29
::: danger DANGER
30
- This is something we do not recommend. Use at your own risk.
30
+ これはお勧めしません。自己責任で使用してください。
31
31
:::
32
32
```
33
33
34
- ** Rendered Markdown **
34
+ ** レンダリングされたマークダウン **
35
35
36
36
::: info
37
- You can find more information at this site.
37
+ あなたはこのサイトでより多くの情報を見つけることができます。
38
38
:::
39
39
40
40
::: tip
41
- This is a great tip to remember !
41
+ これは覚えておくべき素晴らしいヒントです !
42
42
:::
43
43
44
44
::: warning
45
- This is something to be cautious of.
45
+ これは注意が必要なことです。
46
46
:::
47
47
48
48
::: danger DANGER
49
- This is something we do not recommend. Use at your own risk.
49
+ これはお勧めしません。自己責任で使用してください。
50
50
:::
51
51
52
- ## Code Blocks
52
+ ## コードブロック
53
53
54
- VuePress uses Prism to provide language syntax highlighting by appending the language to the beginning backticks of a code block :
54
+ VuePress は、 Prism を使用して、コードブロックの最初のバッククォートに言語を追加することにより、言語構文の強調表示を提供します :
55
55
56
- ** Markdown Example **
56
+ ** マークダウンの例 **
57
57
58
58
````
59
59
```js
@@ -63,20 +63,20 @@ export default {
63
63
```
64
64
````
65
65
66
- ** Rendered Output **
66
+ ** レンダリングされた出力 **
67
67
``` js
68
68
export default {
69
69
name: ' MyComponent'
70
70
}
71
71
```
72
72
73
- ### Line Highlighting
73
+ ### 行の強調表示
74
74
75
- To add line highlighting to your code blocks, you need to append the line number in curly braces.
75
+ コードブロックに行の強調表示を追加するには、中括弧で行番号を追加する必要があります。
76
76
77
- #### Single Line
77
+ #### 一行
78
78
79
- ** Markdown Example **
79
+ ** マークダウンの例 **
80
80
81
81
````
82
82
```js{2}
@@ -90,7 +90,7 @@ export default {
90
90
```
91
91
````
92
92
93
- ** Rendered Markdown **
93
+ ** レンダリングされたマークダウン **
94
94
95
95
``` js{2}
96
96
export default {
@@ -102,7 +102,7 @@ export default {
102
102
}
103
103
```
104
104
105
- #### Group of Lines
105
+ #### 行のグループ
106
106
107
107
````
108
108
```js{4-5}
@@ -126,7 +126,7 @@ export default {
126
126
}
127
127
```
128
128
129
- #### Multiple Sections
129
+ #### 複数のセクション
130
130
131
131
````
132
132
```js{2,4-5}
0 commit comments