ブログに戻る
markdown 2025-02-20

Markdown:開発者の必須ライティングツール

このガイドでドキュメント、READMEファイル、技術文書のためのMarkdown構文をマスターしましょう。

Markdownは、2004年にJohn Gruberが作成した軽量マークアップ言語です。開発者ドキュメント、READMEファイル、技術文書の標準となりました。

なぜMarkdownか?

  • シンプルな構文:学びやすく、生テキストでも読みやすい
  • ポータブル:プレーンテキストファイルはどこでも動作
  • 広くサポート:GitHub、GitLab、Stack Overflow、Notionなど
  • バージョン管理に優しい:テキストdiffがクリーンで意味がある

必須の構文

見出し

見出し1

見出し2

見出し3

テキストフォーマット

太字

イタリック

~~取り消し線~~

インラインコード

リンクと画像

[リンクテキスト](https://example.com)

![代替テキスト](image.png)

良いREADMEファイルの書き方

1. プロジェクト名と説明

2. インストール手順

3. コード付きの使用例

4. 設定オプション

5. コントリビューションガイドライン

6. ライセンス情報

Markdownプレビューツールでリアルタイムにプレビューできます。