MkDocs

Akses

• Buka: http://SERVER_IP

Menyunting & menerbitkan konten

1. Tambahkan atau sunting berkas Markdown: /opt/mkdocs/docs

2. Jika Anda menambah atau mengganti nama halaman, perbarui /opt/mkdocs/mkdocs.yml for navigation.

3. Bangun ulang situsnya:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx menyajikan berkas hasil build dari: /opt/mkdocs/site

Tidak perlu memulai ulang Nginx setelah build ulang.

Path Penting

• Proyek: /opt/mkdocs
• Konten: /opt/mkdocs/docs
• Konfigurasi: /opt/mkdocs/mkdocs.yml
• Hasil build: /opt/mkdocs/site
• Lingkungan virtual Python: /opt/mkdocs/venv
• Berkas eksekusi MkDocs: /opt/mkdocs/venv/bin/mkdocs
• Konfigurasi Nginx: /etc/nginx/sites-available/mkdocs.conf

Domain & HTTPS

1. Arahkan domain Anda ke alamat IP server.

2. Sunting konfigurasi Nginx dan ganti server_name _; dengan domain Anda (misalnya, server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. Uji konfigurasinya:

nginx -t

4. Pasang Certbot:

apt install -y certbot python3-certbot-nginx

5. Buat sertifikat Let's Encrypt:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. Muat ulang Nginx:

systemctl reload nginx

7. Perbarui URL situs MkDocs: ganti site_url: 'http://<SERVER_IP>/' dengan site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Bangun ulang situsnya:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. Buka browser kamu dan kunjungi: https://<YOUR_DOMAIN>

Catatan

• Perubahan Markdown harus dibangun ulang sebelum muncul di situs publik.
• Nginx serves the generated files from /opt/mkdocs/site.
• Ubah mkdocs.yml dan konfigurasi proyek sesuai preferensi Anda.