ドキュメントタイトル (H1)

メインセクション (H2)

サブセクション (H3)

サブサブセクション (H4)

別のメインセクション (H2)

サブセクション (H3)

これはしないでください：

タイトル1

タイトル3 (H2をスキップ)

ドキュメントタイトル

これはドキュメントの導入部です。

第1章

これは第1章のコンテンツです。

1.1 サブセクション

これはサブセクションのコンテンツです。

• リストアイテム1
• リストアイテム2

コード例：

console.log("Hello World");

第2章

これは第2章のコンテンツです。

この記事では、Markdownの使用について論じ、
GitHubでの適用方法について説明します。

Stack Overflowのベストプラクティスについても言及します。

利点：

1. 中央集権的なリンク管理
2. よりクリーンな読書体験
3. より簡単な保守

プロジェクトドキュメンテーション

• クイックスタート
• APIドキュメンテーション
• FAQ

画像参照：

相対パスの利点：

• 簡単なドキュメント移行
• オフライン閲覧サポート
• 保守コストの削減

良い習慣：

function calculateSum(a, b) {
  return a + b;
}

def calculate_sum(a, b):
  return a + b

これは避けてください：

function calculateSum(a, b) {
  return a + b;
}

// ユーザー認証ミドルウェア
function authenticateUser(req, res, next) {
  // リクエストヘッダーからトークンを取得
  const token = req.headers.authorization;
  
  if (!token) {
      // トークンがない場合は401エラーを返す
      return res.status(401).json({ error: 'トークンが提供されていません' });
  }
  
  try {
      // トークンの有効性を確認
      const decoded = jwt.verify(token, process.env.JWT_SECRET);
      req.user = decoded;
      next();
  } catch (error) {
      // 無効なトークンを処理
      return res.status(403).json({ error: '無効なトークン' });
  }
}

推奨形式：

同様に受け入れ可能（同じ機能）：

良い習慣：
これは適切な長さの段落です。読みにくくなるほど長すぎず、
断片的に見えるほど短すぎでもありません。

避けてください：
これは非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に非常に長い段落で、読者を疲れさせ、読書位置を追跡するのが困難になります。

これも避けてください：
短すぎます。
段落です。
読みにくいです。

プロジェクト機能

私たちのプロジェクトには以下の機能があります：

• 高性能：最適化されたアルゴリズムとデータ構造
• 使いやすさ：直感的なAPI設計
• 拡張可能：プラグインベースのアーキテクチャ
• クロスプラットフォーム：複数のオペレーティングシステムをサポート

インストール要件

開始する前に、システムがこれらの要件を満たしていることを確認してください：

1. Node.jsバージョン >= 14.0.0
2. npmバージョン >= 6.0.0
3. OS：Windows 10+、macOS 10.15+、Ubuntu 18.04+
4. メモリ：少なくとも4GB RAM

良い習慣：
これは最初の文です。
これは2番目の文です。
これは3番目の文です。

避けてください：
これは最初の文です。これは2番目の文です。これは3番目の文です。

利点：

• より明確なGit差分
• 変更の追跡がより簡単
• マージ競合の減少

docs/
├── en/
│ ├── README.md
│ ├── getting-started.md
│ └── api.md
├── zh/
│ ├── README.md
│ ├── getting-started.md
│ └── api.md
└── README.md # 言語バージョンにリンクするメインドキュメント

各ドキュメントに言語スイッチャーを追加：

• English
• 中文

画像使用ガイドライン

ローカル画像

オンライン画像（安定性を確保）

大きな画像の圧縮

大きな画像については以下を検討：

• 適切な解像度を使用
• 適切な形式を選択（WebP、PNG、JPEG）
• 複数サイズのバージョンを提供

代替テキストの追加

すべての画像には説明的な代替テキストが必要で、
これはアクセシビリティとSEOにとって重要です。

ドキュメントタイトル - テキスト変換に明確

テキストフレンドリーな見出しを持つセクション

サブセクション：テキスト形式で読みやすい

クリーンに変換される一貫した書式を使用：

• 箇条書きはmarkdown テキスト変換出力で構造を維持
• 読みやすさのために段落の長さを適度に保つ
• テキストナビゲーションのために明確で説明的な見出しを使用

太字の強調はテキスト変換でうまく機能します。
斜体テキストはmarkdown テキスト変換処理で保持されます。

コードブロックはテキスト形式でもコンテキストを提供
markdown テキスト変換ドキュメンテーションワークフローに最適

ブロック引用はテキスト変換で意味を維持
重要な情報を強調するのに有用

MDからテキストコンバーターのようなリンクは
テキスト出力でアクセス可能のままです。

Markdown テキスト変換ワークフローのための推奨ツール

テキスト変換エディタ

• Typora：優秀なテキストエクスポートを持つWYSIWYGエディタ
• Mark Text：クリーンなテキスト出力を持つリアルタイムプレビュー
• VS Code：テキスト変換に最適化されたMarkdown拡張機能
• Obsidian：優秀なmarkdown テキスト変換機能を持つノート取り

Markdownコンバーターツール

• Pandoc：テキスト出力を持つユニバーサルドキュメントコンバーター
• Marked：markdown テキスト変換の高速処理
• Turndown：テキストワークフローのためのHTMLからMarkdownへの変換
• Remark：テキスト変換のための強力なMarkdownプロセッサ

テキスト処理プラットフォーム

• GitBook：クリーンなテキストエクスポートを持つドキュメンテーション
• VuePress：markdown テキスト変換サポートを持つ静的サイトジェネレーター
• Gatsby：markdown テキスト変換機能を持つReactベースのプラットフォーム
• Docusaurus：テキスト出力に最適化されたFacebookのプラットフォーム

オンラインテキスト変換ツール

• MDからテキストコンバーター：特化したmarkdown テキスト変換処理
• StackEdit：テキストエクスポート機能を持つオンラインエディタ
• Dillinger：クリーンなテキスト出力を持つクラウドMarkdownエディタ
• Markdown Live Preview：リアルタイムテキスト変換プレビュー

コマンドラインテキスト処理

• Pandoc CLI：コマンドラインからのmarkdown テキスト変換
• Marked CLI：Markdownからの高速テキスト処理
• Remark CLI：高度なテキスト変換ワークフロー
• カスタムスクリプト：自動化されたmarkdown テキスト変換バッチ処理