アクセス
- 開きます:
http://SERVER_IP
コンテンツの編集と公開
1. Markdown ファイルを追加または編集します: /opt/mkdocs/docs
2. ページを追加または名前変更した場合は、次を更新します: /opt/mkdocs/mkdocs.yml for navigation.
3. サイトを再ビルドします:
/opt/mkdocs/venv/bin/mkdocs build --clean \
--config-file /opt/mkdocs/mkdocs.yml \
--site-dir /opt/mkdocs/site
Nginx は生成されたファイルを次の場所から配信します: /opt/mkdocs/site
再ビルド後に Nginx を再起動する必要はありません。
重要なパス
- プロジェクト:
/opt/mkdocs - コンテンツ:
/opt/mkdocs/docs - 設定:
/opt/mkdocs/mkdocs.yml - ビルド出力:
/opt/mkdocs/site - Python の仮想環境:
/opt/mkdocs/venv - MkDocs の実行ファイル:
/opt/mkdocs/venv/bin/mkdocs - Nginx の設定:
/etc/nginx/sites-available/mkdocs.conf
ドメインと HTTPS
1. ドメインをサーバーの IP アドレスに向けます。
2. Nginx の設定を編集し、次を置き換えます: server_name _; を自分のドメインに置き換えます（例: server_name <YOUR_DOMAIN>;):
vim /etc/nginx/sites-available/mkdocs.conf
3. 設定をテストします:
nginx -t
4. Certbot をインストールします:
apt install -y certbot python3-certbot-nginx
5. Let's Encrypt の証明書を生成します:
certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>
6. Nginx を再読み込みします:
systemctl reload nginx
7. MkDocs サイトの URL を更新します: 次を置き換えます site_url: 'http://<SERVER_IP>/' を次に: site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.
8. サイトを再ビルドします:
/opt/mkdocs/venv/bin/mkdocs build --clean \
--config-file /opt/mkdocs/mkdocs.yml \
--site-dir /opt/mkdocs/site
9. ブラウザを開いて次にアクセス: https://<YOUR_DOMAIN>
注意事項
- Markdown の変更は、再ビルドしてから公開サイトに反映されます。
- Nginx serves the generated files from
/opt/mkdocs/site. - 変更します
mkdocs.ymlとプロジェクト設定を、好みに応じて変更してください。
