|
1 | 1 | # マークダウンルール {#markdown-rules} |
2 | 2 |
|
3 | | -TiDBのドキュメントはMarkdownで記述されています。品質とフォーマットの一貫性を保つため、ドキュメントを変更する際には特定のMarkdownルールに従う必要があります。docsリポジトリ( [マークダウンリントチェック](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md)内のMarkdownファイルにはCIチェックを設定しています。 |
| 3 | +TiDBのドキュメントはMarkdownで記述されています。品質とフォーマットの一貫性を保つため、ドキュメントを変更する際には特定のMarkdownルールに従う必要があります。docsリポジトリ内のMarkdownファイルには、CIチェック( [マークダウンリントチェック](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md))を設定しています。 |
4 | 4 |
|
5 | 5 | ルールに準拠していないプルリクエスト(PR)を送信した場合、PRが**markdownlintチェックに合格しない**可能性があります。その場合、このPRをマージできない可能性があります。 |
6 | 6 |
|
@@ -35,9 +35,9 @@ PRを送信する前に関連するMarkdownルールをよく理解しておら |
35 | 35 | | 17 | [MD032 - リストは空白行で囲む必要があります](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines) | リスト (あらゆる種類) の前後には空白行が必要です。 | |
36 | 36 | | 18 | [MD031 - 囲まれたコードブロックは空白行で囲む必要があります](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031---fenced-code-blocks-should-be-surrounded-by-blank-lines) | コード ブロックの前後には空白行が必要です。 | |
37 | 37 | | 19 | [MD034 - ベアURLが使用されている](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034---bare-url-used) | ドキュメント内ではURLそのものの使用は許可されていません。ユーザーがURLを直接クリックして開くようにしたい場合は、URLを山括弧で囲んでください( `<URL>` )。特別な状況下でURLそのものを使用する必要がある場合、ユーザーがクリックして開く必要がない場合は、URLをバッククォートで囲んでください( `` `URL` `` )。 | |
38 | | -| 20 | [MD037 - 強調マーカー内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md037---spaces-inside-emphasis-markers) | 強調マーカー(太字、斜体)を使用する場合、強調マーカー内に余分なスペースを入れることはできません。例えば、 `** bold text **`許可されません。 | |
39 | | -| 21 | [MD038 - コードスパン要素内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038---spaces-inside-code-span-elements) | コード範囲要素をバッククォートで囲む場合、コード範囲内に余分なスペースを含めることはできません。例えば、 `` ` example text ` ``許可されません。 | |
40 | | -| 22 | [MD039 - リンクテキスト内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039---spaces-inside-link-text) | リンクテキストの両側に余分なスペースを入れることはできません。例えば、 `[ a link ](https://www.example.com/)`許可されません。 | |
41 | | -| 23 | [MD042 - 空のリンクはありません](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042---no-empty-links) | リンクには必ず宛先が必要です。例えば、 `[empty link 1]()`と`[empty link 2](#)`許可されません。 | |
| 38 | +| 20 | [MD037 - 強調マーカー内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md037---spaces-inside-emphasis-markers) | 強調マーカー(太字、斜体)を使用する場合、強調マーカー内に余分なスペースを入れることはできません。例えば、 `** bold text **`は許可されません。 | |
| 39 | +| 21 | [MD038 - コードスパン要素内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038---spaces-inside-code-span-elements) | コード範囲要素をバッククォートで囲む場合、コード範囲内に余分なスペースを含めることはできません。例えば、 `` ` example text ` ``は許可されません。 | |
| 40 | +| 22 | [MD039 - リンクテキスト内のスペース](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039---spaces-inside-link-text) | リンクテキストの両側に余分なスペースを入れることはできません。例えば、 `[ a link ](https://www.example.com/)`は許可されません。 | |
| 41 | +| 23 | [MD042 - 空のリンクはありません](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042---no-empty-links) | リンクには必ず宛先が必要です。例えば、 `[empty link 1]()`と`[empty link 2](#)`は許可されません。 | |
42 | 42 | | 24 | [MD045 - 画像には代替テキストが必要です(altテキスト)](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md045---images-should-have-alternate-text-alt-text) | 画像には代替テキスト(altテキスト)が必要です。altテキスト`![]()` `[]`で記述されます。画像の読み込みに失敗した人のために、画像の内容を説明するものです。 | |
43 | 43 | | 25 | [MD046 - コードブロックスタイル](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md046---code-block-style) | ドキュメント内のコードブロックを囲むには、 **3つのバッククォート**` ``` `を使用してください。コードブロックを示すために**4つのスペースによるインデント**を使用し**ない**でください。 | |
0 commit comments