Markdown ライティングガイド

基本的な記法

Markdown を使えば、シンプルなテキストから構造化されたドキュメントを作成できます。

テキスト装飾

• 太字 は **太字** で書きます
• イタリック は *イタリック* で書きます
• 取り消し線 は ~~取り消し線~~ で書きます

リスト

順序なしリスト:

• 項目 A
• 項目 B
  • ネストされた項目
• 項目 C

順序付きリスト:

1. 最初のステップ
2. 次のステップ
3. 最後のステップ

コードの記述

インラインコードは const x = 1 のようにバッククォートで囲みます。

コードブロックは言語を指定して構文ハイライトを有効にします:

function greet(name) {
  return `こんにちは、${name}さん！`;
}

console.log(greet('世界'));

article {
  max-width: 48rem;
  margin-inline: auto;
}

テーブル

引用（ブロッククォート）

これはブロッククォートです。重要な情報や引用を目立たせるために使います。 複数行にわたって書くこともできます。

画像

画像は以下の記法で挿入します:

![代替テキスト](/images/example.png)

リンク

• 内部リンクの例
• 外部リンクの例

ベストプラクティス

記事を書くときのコツ: 見出しの階層を正しく保ちましょう。h1 はタイトルとして自動的に挿入されるため、記事本文では h2 から始めてください。

1. 段落は短めに保つ
2. 見出しで構造を明確にする
3. コードには必ず言語指定をする
4. 画像には代替テキストを付ける