Dostęp
- Otwórz:
http://SERVER_IP
Edycja i publikowanie treści
1. Dodaj lub edytuj pliki Markdown: /opt/mkdocs/docs
2. Jeśli dodajesz lub zmieniasz nazwy stron, zaktualizuj /opt/mkdocs/mkdocs.yml for navigation.
3. Przebuduj witrynę:
/opt/mkdocs/venv/bin/mkdocs build --clean \
--config-file /opt/mkdocs/mkdocs.yml \
--site-dir /opt/mkdocs/site
Nginx udostępnia wygenerowane pliki z: /opt/mkdocs/site
Po przebudowaniu nie trzeba restartować Nginx.
Ważne ścieżki
- Projekt:
/opt/mkdocs - Treść:
/opt/mkdocs/docs - Konfiguracja:
/opt/mkdocs/mkdocs.yml - Wynik budowania:
/opt/mkdocs/site - Wirtualne środowisko Pythona:
/opt/mkdocs/venv - Plik wykonywalny MkDocs:
/opt/mkdocs/venv/bin/mkdocs - Konfiguracja Nginx:
/etc/nginx/sites-available/mkdocs.conf
Domena i HTTPS
1. Skieruj swoją domenę na adres IP serwera.
2. Edytuj konfigurację Nginx i zamień server_name _; na swoją domenę (na przykład server_name <YOUR_DOMAIN>;):
vim /etc/nginx/sites-available/mkdocs.conf
3. Przetestuj konfigurację:
nginx -t
4. Zainstaluj Certbota:
apt install -y certbot python3-certbot-nginx
5. Wygeneruj certyfikat Let's Encrypt:
certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>
6. Przeładuj Nginx:
systemctl reload nginx
7. Zaktualizuj adres URL witryny MkDocs: zamień site_url: 'http://<SERVER_IP>/' na site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.
8. Przebuduj witrynę:
/opt/mkdocs/venv/bin/mkdocs build --clean \
--config-file /opt/mkdocs/mkdocs.yml \
--site-dir /opt/mkdocs/site
9. Otwórz przeglądarkę i odwiedź: https://<YOUR_DOMAIN>
Uwagi
- Zmiany w Markdown trzeba przebudować, zanim pojawią się na publicznej stronie.
- Nginx serves the generated files from
/opt/mkdocs/site. - Zmień
mkdocs.ymloraz konfigurację projektu według swoich preferencji.
