コンテンツにスキップ

コンテンツ作成者向けローカルプレビュー

変更をプッシュする前に、ドキュメントをローカルでプレビューできます。必要なのはDockerとdocs/ディレクトリだけです。

  • Docker Desktopがインストールされ、実行中であること
  • 少なくともindex.mdxを含むdocs/ディレクトリがあるコンテンツリポジトリがローカルにクローンされていること

コンテンツリポジトリのルートから、以下を実行します:

Terminal window
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 を開きます。

画像はdocs/images/のようなサブディレクトリに配置します。コンテナがこれらを自動的に検出するため、追加のボリュームマウントは不要です。

MDXではルート相対パスで参照します:

![Architecture diagram](/images/architecture.png)

ポートが既に使用中 — 別のホストポートにマッピングします:-p 8080:4321、その後http://localhost:8080を開きます。

コンテンツが表示されないdocs/index.mdxが存在するか確認してください。コンテナの出力にERROR: No content foundメッセージがないか確認してください。

古いイメージ — 最新バージョンをプルします:

Terminal window
docker pull ghcr.io/f5-sales-demo/docs-builder:latest
  • Dockerビルド — イメージの詳細、環境変数、本番ビルド
  • アーキテクチャ — コンテンツインジェクションモデルとテーマシステム設計