MkDocs

Доступ

• Відкрийте: 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. Оновіть URL сайту MkDocs: замініть 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 і конфігурацію проєкту на свій розсуд.