Доступ
- Откройте:
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и конфигурацию проекта по своему усмотрению.
