- ホーム
- ドキュメントビルダー
- コンテンツ作成者向けローカルプレビュー
コンテンツ作成者向けローカルプレビュー
変更をプッシュする前に、ドキュメントをローカルでプレビューできます。必要なのはDockerとdocs/ディレクトリだけです。
- Docker Desktopがインストールされ、実行中であること
- 少なくとも
index.mdxを含むdocs/ディレクトリがあるコンテンツリポジトリがローカルにクローンされていること
開発サーバーの起動
Section titled “開発サーバーの起動”コンテンツリポジトリのルートから、以下を実行します:
docker run --rm -it \ -v "$(pwd)/docs:/content/docs" \ -p 4321:4321 \ -e MODE=dev \ ghcr.io/f5-sales-demo/docs-builder:latestサーバーが起動したら http://localhost:4321 を開きます。
画像と静的アセット
Section titled “画像と静的アセット”画像はdocs/images/のようなサブディレクトリに配置します。コンテナがこれらを自動的に検出するため、追加のボリュームマウントは不要です。
MDXではルート相対パスで参照します:
トラブルシューティング
Section titled “トラブルシューティング”ポートが既に使用中 — 別のホストポートにマッピングします:-p 8080:4321、その後http://localhost:8080を開きます。
コンテンツが表示されない — docs/index.mdxが存在するか確認してください。コンテナの出力にERROR: No content foundメッセージがないか確認してください。
古いイメージ — 最新バージョンをプルします:
docker pull ghcr.io/f5-sales-demo/docs-builder:latest