mcpField
D
documentation-site-setup

documentation-site-setup

github.com/aj-geddes開発373449 回インストール34 週間前に更新
リポジトリ

documentation-site-setup について

Docusaurus、MkDocs、VitePress、GitBookなどを使った静的ドキュメントサイトの構築を支援するスキルです。サイトの設定に加え、構成、バージョン管理、デプロイも扱います。

主な機能

  1. 01Docusaurus、MkDocs、VitePress、GitBook
  2. 02インストールとプロジェクト構成ガイド
  3. 03サイドバーとサイト設定
  4. 04ドキュメントのバージョン管理とデプロイ

活用シーン

  1. 01製品ドキュメントサイトの構築
  2. 02APIドキュメントポータルの作成
  3. 03複数バージョンの技術文書の公開
  4. 04静的ドキュメントサイトのデプロイ

インストール

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

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

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

同梱ファイル

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

references/
admonitions.md
configuration-2.md
configuration-3.md
configuration.md
installation-2.md
installation-3.md
installation-4.md
installation.md
sidebar-configuration.md
versioning.md
templates/
component-template.tsx

詳細

ドキュメントサイトのセットアップ

目次

概要

Docusaurus、MkDocs、VitePress、GitBook などの人気の静的サイトジェネレーターを使用して、プロフェッショナルなドキュメントサイトをセットアップします。

使用する場面

  • ドキュメントサイトのセットアップ
  • API ドキュメントポータル
  • 製品ドキュメントサイト
  • 技術ドキュメントハブ
  • 静的サイトの生成
  • GitHub Pages へのデプロイ
  • 複数バージョンのドキュメント

クイックスタート

  • 複数バージョンのドキュメント
# Create new Docusaurus site
npx create-docusaurus@latest my-docs classic

cd my-docs

# Install dependencies
npm install

# Start development server
npm start

リファレンスガイド

詳細な実装については、references/ ディレクトリを参照してください。

ガイド内容
インストールインストール、プロジェクト構成
設定設定
サイドバーの設定サイドバーの設定
バージョン管理バージョン管理、デプロイ
インストールインストール、プロジェクト構成
設定設定
注意書き注意書き、デプロイ
インストールインストール
設定設定
インストールインストール、プロジェクト構成、設定、目次

ベストプラクティス

✅ 推奨事項
  • 一貫性のあるナビゲーション構成を使用する
  • 検索機能を有効にする
  • ページに編集リンクを追加する
  • バージョン管理されたドキュメントにはバージョンセレクターを含める
  • コードブロックにシンタックスハイライトを使用する
  • ダークモードに対応する
  • 画像やアセットを最適化する
  • アナリティクスを有効にする
  • ソーシャルメディアへのリンクを追加する
  • レスポンシブデザインを採用する
  • パンくずリストを含める
  • 目次を追加する
  • モバイルデバイスでテストする
❌ 避けるべきこと
  • 古いフレームワークを使用する
  • 検索機能を省略する
  • モバイル対応を忘れる
  • 読み込みの遅いアセットを使用する
  • アクセシビリティ機能を省略する
  • SEO の最適化を無視する

コメント

Markdown 対応