mcpField
M
markdown-documentation

markdown-documentation

github.com/aj-geddesドキュメント3731.3k 回インストール34 週間前に更新
リポジトリ

markdown-documentation について

標準 Markdown と GitHub Flavored Markdown で読みやすいドキュメントを作成するスキルです。README、ガイド、Wiki などを書くテクニカルライターやプロジェクトメンテナーを対象としています。

主な機能

  1. 01Markdown のテキストとリストの書式
  2. 02リンク、画像、コードブロック
  3. 03表と拡張 GFM 構文
  4. 04アラート、コールアウト、Mermaid 図

活用シーン

  1. 01プロジェクト README の作成
  2. 02技術ドキュメントの整形
  3. 03GitHub または GitLab Wiki の作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation

インストール後、Claude Code で/markdown-documentationを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
alerts-and-callouts.md
collapsible-sections.md
extended-syntax-github-flavored-markdown.md
links-and-images.md
lists.md
mermaid-diagrams.md
text-formatting.md
templates/
doc-template.md

詳細

Markdown ドキュメント

目次

概要

標準の Markdown と GitHub Flavored Markdown（GFM）を使用して、適切に書式設定された読みやすいドキュメントを作成するための Markdown 構文とベストプラクティスを習得します。

使用する場面

  • README ファイル
  • ドキュメントページ
  • GitHub／GitLab の Wiki
  • ブログ記事
  • 技術文書
  • プロジェクトドキュメント
  • コメントの書式設定

クイックスタート

  • コメントの書式設定
# H1 Header

## H2 Header

### H3 Header

#### H4 Header

##### H5 Header

###### H6 Header

# Alternative H1

## Alternative H2

リファレンスガイド

references/ ディレクトリにある詳細な実装ガイド：

ガイド内容
テキストの書式設定テキストの書式設定
リストリスト
リンクと画像リンクと画像、コードブロック、表
拡張構文（GitHub Flavored Markdown）拡張構文（GitHub Flavored Markdown）
折りたたみ可能なセクション折りたたみ可能なセクション、構文のハイライト、バッジ
アラートとコールアウトアラートとコールアウト
Mermaid 図Mermaid 図

ベストプラクティス

✅ 推奨事項
  • 内容がわかるリンクテキストを使用する
  • 長いドキュメントには目次を含める
  • 画像に代替テキストを追加する
  • 言語を指定したコードブロックを使用する
  • 1 行を 80〜100 文字以内に収める
  • 内部ドキュメントには相対リンクを使用する
  • ビルドステータスやカバレッジなどのバッジを追加する
  • 例やスクリーンショットを含める
  • 意味が伝わる改行を使用する
  • すべてのリンクを定期的にテストする
❌ 避けるべきこと
  • リンクテキストに「ここをクリック」を使用する
  • 画像の代替テキストを忘れる
  • HTML と Markdown を不必要に混在させる
  • ローカルファイルに絶対パスを使用する
  • 改行を入れずにテキストを詰め込む
  • コードブロックで言語指定を省略する
  • テキストコンテンツに画像を使用する（アクセシビリティ上の問題）

コメント

Markdown 対応