ドキュメントサイトを
静的サイトとして公開
VitePress、Docusaurus、Nextra、VuePress、MkDocs などの静的ドキュメント出力を、検索しやすい HTML、独自ドメイン、HTTPS、更新しやすい公開手順で公開できます。
よく使われるドキュメント形式
ドキュメント公開でつまずきやすいところ
ツールの制約が出てくる
ホスト型ドキュメントツールは便利ですが、ブランド表現、独自ページ、最終的なサイト制御で制限に当たることがあります。
Wiki だけでは足りない
社内メモなら Wiki で足ります。公開ドキュメントでは検索、読みやすいナビゲーション、独自ドメイン、メタ情報、第一印象が必要です。
自前運用に時間を取られる
サーバー、SSL、公開フック、リリース管理に時間を使いすぎると、肝心のドキュメント改善が進みません。
公開前にビルドを確認
生成されたフォルダをアップロード
Docusaurus は build、VitePress は .vitepress/dist、MkDocs は site を生成します。Markdown のソースではなく、生成済みファイルをアップロードします。
base設定を確認
ドキュメントをサブパスやプロジェクト配下に置く場合は、フレームワーク側のbase URLが最終URLと合っているか確認します。
検索とナビゲーションを試す
公開前に本番ビルドをローカルで開き、検索インデックス、サイドバー、バージョン別パス、深いリンクを確認します。
アセットをキャッシュしやすくする
ドキュメントサイトは画像、フォント、JavaScript が多くなりがちです。静的出力ならキャッシュしやすい形で配信できます。
さまざまなドキュメントに対応
オープンソースのドキュメント
ガイド、変更履歴、移行メモをブランドドメインで公開し、運用だけの別プロジェクトにしないで済みます。
API リファレンス
検索、ナビゲーション、コード向けレイアウトを備えた、読みやすいリファレンスサイトを公開します。
社内ナレッジベース
エンジニアリング handbook、runbook、手順書を整理されたサイト構造で公開できます。
プロダクトドキュメント
オンボーディング、セットアップガイド、機能リファレンスを、顧客が開きやすい静的サイトとして公開します。
デザインシステム
コンポーネントの使い方、トークン、パターンを、プロダクトの成長に合わせて見やすく公開できます。
主要な静的ドキュメントスタックに対応
ドキュメント公開のよくある質問
VitePress や Docusaurus の出力を公開できますか？
はい。先にフレームワーク側でビルドし、生成された静的出力フォルダをアップロードします。DeployPages は最終的な HTML、CSS、JavaScript、画像を配信します。
ドキュメントサイトの独自ドメインはどう設定しますか？
公開後にドメインを追加し、提示された DNS レコードを設定します。解決後に HTTPS が準備されます。
非公開ドキュメントにも使えますか？
現時点で最も向いているのは公開ドキュメントやオープンな製品ドキュメントです。必要に応じてパスワード保護を使い、公開範囲を慎重に決めてください。
SEO にも役立ちますか？
はい。静的HTML、読みやすいURL、適切なメタ情報、速い配信は、検索に見つけてもらいやすいドキュメントの土台になります。
生成済みドキュメントをサイトとして公開
ビルド済みのドキュメントフォルダをアップロードし、読者が探しやすい場所を用意します。
HTML、CSS、JavaScript、一般的な静的ドキュメントのアセットに対応します。