概要
Markdown 執筆 コース
この Markdown 執筆コースで学ぶ内容を紹介します。
このコースでは、開発者向け執筆形式としての Markdown を学びます。Markdown 自体は出版システムではありません。GitHub、ドキュメントサイト、Issue トラッカー、多くの CMS ツールがレンダリング方法を知っているプレーンテキストと軽量構文です。
開発者が最もよく使う構文、README や Issue ワークフローに現れる GitHub Flavored Markdown 拡張、プレビューと HTML エクスポートが実際のドキュメント作業にどう組み込まれるかを学びます。
対象者
- README、CHANGELOG、プロジェクトドキュメントを書く開発者
- GitHub Issue、PR 説明、RFC メモを起草するエンジニア
- 高速なプレーンテキスト下書き形式が必要なテクニカルライター
- リポジトリ、ドキュメントツール、CMS フィールド間でコンテンツを移動する人
学ぶこと
- Markdown とは何か、開発者ワークフローにどこで現れるか
- コア構文：見出し、リスト、リンク、強調、コード
- GitHub Flavored Markdown の表、フェンスコードブロック、タスクリスト
- README と Issue テンプレートの構造
- プレビューとサニタイズされた HTML エクスポート
- 公開前の実践的なレビューワークフロー
読みながら関連する Markdown Preview / Markdown to HTML ツールを使ってください。目的は一度プレビューすることだけでなく、GitHub、ドキュメントパイプライン、HTML エクスポート経路で読みやすいドキュメントを書くことです。