Instruction file imported from fehde-k/zenn-public (
.github/instructions/markdown.instructions.md). Copyright stays with the author.
Apply the general coding guidelines to all code.
Markdown Common Guidelines
-
表を作成または編集する際、あるセルがその真上のセルと同じ内容である場合、かつ、その行においてそのセルより左にある全てのセルが空欄である（あるいは、上の行と同じ内容であるために空欄化されている）場合に限り、そのセルを空欄にしてください。これにより、表の視認性を向上させます。
例:
修正前:
Category Item Value Fruit Apple 100 Fruit Banana 200 Vegetable Carrot 150 Vegetable Potato 50 Vegetable Potato 60 修正後:
Category Item Value Fruit Apple 100 Banana 200 Vegetable Carrot 150 Potato 50 60 -
Markdown ドキュメント内で、見出し (例:
# 見出し,## 見出し) が一つも重複しないようにしてください。 -
YouTube の URL は、各動画のタイトルを取得し、タイトル付きのマークダウンリンクを作成してください。
-
意味のない空白は削除してください。
Mermaid Common Guidelines
- mermaid 図のコードブロック内で
//の文字列で始まるコメントは使わないでください。パースエラーになります。 - mermaid 図のコメントは、必ず別の行に書いてください。ノードの ID やラベル内にコメントを入れると、パースエラーの原因になります。
Mermaid Mindmap Guidelines
- root とレベル1のノードは二重丸括弧
((node))で囲む。 - レベル2のノードは一重括弧
(node)で囲む。 - レベル3以降のノードはデフォルトのスタイル(角丸四角形)を使用する。
- 注意: Mermaid 図の構文では、ノード ID やラベル内、矢印の前後などに不必要なスペースを入れるとパースエラーの原因となることがあります。スペースの挿入には注意してください。
- 注意: Mermaid 図が複雑で大きい場合は、視認性を高めるために、関連する部分ごとにコードブロックを分割してください。