Markdown
「Markdown」カテゴリの技術記事。エラー解決から入門講座まで幅広く掲載しています。
8 件
「Markdown」カテゴリの技術記事。エラー解決から入門講座まで幅広く掲載しています。
人気記事から読み始めることをおすすめします。
人気記事
初心者向け
おすすめの学習順序
関連カテゴリ
実践:プロジェクトREADMEを一から作る|Markdown総仕上げ
これまでの記法と構成を統合し、サンプルAPIプロジェクトのREADMEをゼロから作成する手順と品質チェックリスト、よくある仕上げミスを解説します。
エディタ・プレビュー・Lint|Markdown執筆を効率化するツール
VS CodeのMarkdown機能、markdownlint、Prettier、プレビュー拡張、静的サイト生成の選び方と、ツール設定でつまずく失敗例を解説します。
技術ドキュメントの構成設計|読まれるMarkdownの組み立て方
設計書・手順書・ADRの役割分担、docsディレクトリ構成、読者別の情報設計と、肥大化・重複などの失敗例を解説します。
GitHub READMEの書き方|公開リポジトリの顔を整える
GitHub READMEの推奨構成、バッジ・目次・スクリーンショット、ライセンスとコントリビューションの書き方と、見落としがちな失敗例を解説します。
コードブロックと表|Markdownで技術内容を正確に書く
インラインコード、フェンス付きコードブロック、言語指定、表(table)の記法と、コピペ不能・表崩れなどの失敗例を解説します。
リスト・リンク・画像|Markdownで情報を整理する
箇条書き・番号付きリスト、ネスト、リンク・画像の記法と相対パス・URLの失敗例を解説。READMEで壊れやすいリンク対策も紹介します。
見出し・段落・強調の基本|Markdown記法入門
Markdownの見出し(#)、段落、太字・斜体・打ち消し線の書き方とよくある失敗を解説。プレビューと表示がずれる原因も押さえます。
Markdownとは?技術文書を書く理由と全体像
MarkdownはREADME・設計書・ブログで使われる軽量マークアップ言語です。WordやHTMLとの違い、技術ドキュメントで選ばれる理由を、具体例と失敗例つきで解説します。