スロット攻略 プロジェクトドキュメント

Appearance

VitePress ドキュメント公開（docs.slotkouryaku.com） ​

概要 ​

VitePress でビルドしたプロジェクトドキュメントを、サブドメイン docs.slotkouryaku.com に公開する手順です。ローカルで npm run docs:dev を起動しなくても、ブラウザでドキュメントを参照できます。

前提条件 ​

  • ConoHa WING 等でサブドメイン docs.slotkouryaku.com を追加し、ドキュメントルートを用意していること
  • デプロイ設定ファイルの準備（config/docs.env）
  • （任意）アクセス制限: Basic 認証や IP 制限で「自分のみ」に限定する場合は、サーバー側で設定すること

設定手順 ​

1. config/docs.env の作成 ​

bash
cp config/docs.env.example config/docs.env
nano config/docs.env

2. 設定する項目 ​

変数説明
DEPLOY_HOSTサーバーのホスト名または IP（本番・ステージングと同一の場合は同じ）
DEPLOY_PORTSSH ポート（省略時は 22）
DEPLOY_USERSSH ログインユーザー名
DEPLOY_SSH_KEY秘密鍵のパス（例: ~/.ssh/your-private-key.pem）
DEPLOY_REMOTE_PATHdocs 用ドキュメントルートのフルパス

DEPLOY_REMOTE_PATH の例（ConoHa WING で docs.slotkouryaku.com を追加した場合）:

/home/your-username/public_html/docs.slotkouryaku.com

3. パーミッション ​

bash
chmod 600 config/docs.env

デプロイ手順 ​

bash
./bin/deploy-docs.sh

このスクリプトは以下を実行します。

  1. npm run docs:build で VitePress をビルド（先に DBML から ER 図 SVG を生成してからビルド。出力: docs/.vitepress/dist/）
  2. rsync でビルド成果物を DEPLOY_REMOTE_PATH にアップロード（既存ファイルは上書き・削除済みファイルは削除）

確認 ​

ブラウザで https://docs.slotkouryaku.com にアクセスし、ドキュメントが表示されることを確認してください。

アクセス制限（任意） ​

「自分のみ」で閲覧したい場合は、サーバー側で次のいずれかを設定してください。

  • Basic 認証: ドキュメントルートに .htaccess と .htpasswd を配置し、Apache の Basic 認証を有効にする
  • IP 制限: 自宅やオフィス等の固定 IP のみ許可するように .htaccess またはサーバー管理画面で設定する

詳細は利用中のレンタルサーバー（ConoHa WING 等）のマニュアルを参照してください。