documentation-site-setup
Docusaurus、MkDocs、VitePress、GitBook などの静的サイトジェネレーターを使用してドキュメントサイトを構築します。ドキュメントサイトの新規作成、ドキュメントポータルのセットアップ、静的ドキュメントの構築が必要な際に活用してください。
description の原文を見る
> Set up documentation websites using Docusaurus, MkDocs, VitePress, GitBook, or static site generators. Use when creating docs sites, setting up documentation portals, or building static documentation.
SKILL.md 本文
ドキュメンテーションサイト設定
目次
概要
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/ ディレクトリの詳細な実装:
| ガイド | 内容 |
|---|---|
Installation | インストール、プロジェクト構造 |
Configuration | 設定 |
Sidebar Configuration | サイドバー設定 |
Versioning | バージョン管理、デプロイ |
Installation | インストール、プロジェクト構造 |
Configuration | 設定 |
Admonitions | 補足、デプロイ |
Installation | インストール |
Configuration | 設定 |
Installation | インストール、プロジェクト構造、設定、目次 |
ベストプラクティス
✅ すべきこと
- 一貫したナビゲーション構造を使用する
- 検索機能を有効にする
- ページにリンク編集を追加する
- バージョン付きドキュメンテーション用のバージョンセレクターを含める
- コードブロックの構文強調表示を使用する
- ダークモードサポートを追加する
- 画像とアセットを最適化する
- 分析を有効にする
- ソーシャルメディアリンクを追加する
- レスポンシブデザインを使用する
- パンくずリストを含める
- 目次を追加する
- モバイルデバイスでテストする
❌ すべきではないこと
- 古いフレームワークを使用する
- 検索機能をスキップする
- モバイルレスポンシブ性を忘れる
- 読み込みが遅いアセットを使用する
- アクセシビリティ機能をスキップする
- SEO 最適化を無視する
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- aj-geddes
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/aj-geddes/useful-ai-prompts / ライセンス: MIT
関連スキル
nature-response
Nature系ジャーナルの原稿修正に対する査読者への回答文について、下書き、チェック、または修正を行うことができます。査読者からのコメント、編集者の決定文、修正指示、回答案の作成、または大幅修正・軽微修正の対応方法に関するご相談があれば、対応いたします。査読報告書や回答文作成のサポートが必要な場合にご利用ください。
microsoft-docs
公式のMicrosoft文書を参照して、Azure、.NET、Agent Framework、Aspire、VS Code、GitHubなど様々な分野の概念、チュートリアル、コード例を検索します。デフォルトではMicrosoft Learn MCPを使用し、learn.microsoft.com外のコンテンツについてはContext7およびAspire MCPを使用します。
API Documentation Lookup
このスキルは、ユーザーが「Effect APIを調べる」「Effectドキュメントを確認する」「Effect関数のシグネチャを探す」「Effect.Xは何をするのか」「Effect.Xの使い方」「Effect APIリファレンス」「Effectドキュメントを取得する」といった質問をした場合や、公式のEffect-TS APIドキュメントから特定の関数シグネチャ、パラメータ、使用例を調べる必要がある場合に使用します。
knowledge-base
このスキルは、ヘルプセンターのアーキテクチャ設計、サポート記事の執筆、検索とセルフサービスの最適化が必要な場合に活用できます。ナレッジベース、ヘルプセンター、サポート記事、セルフサービス、記事テンプレート、検索最適化、コンテンツ分類、ヘルプドキュメントの設計・管理に関するあらゆるタスクで動作します。
markdown
GitHub Flavored Markdown標準に従ったMarkdownファイルのフォーマットと検証ができます。自動的なlinting処理と手動による意味的なレビューを組み合わせることで、ファイルの品質を確保します。
claude-md-enhancer
CLAUDE.mdファイルをプロジェクトタイプに合わせて分析・生成・改善します。ベストプラクティス、モジュール設計対応、技術スタックのカスタマイズに対応しています。新規プロジェクトの立ち上げ、既存のCLAUDE.mdファイルの改善、またはAI支援開発の標準化を図る際にご活用ください。