MkDocs

Truy cập

• Mở: http://SERVER_IP

Sửa và xuất bản nội dung

1. Thêm hoặc sửa các tệp Markdown: /opt/mkdocs/docs

2. Nếu bạn thêm hoặc đổi tên trang, hãy cập nhật /opt/mkdocs/mkdocs.yml for navigation.

3. Build lại trang:

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

Nginx phục vụ các tệp đã tạo từ: /opt/mkdocs/site

Không cần khởi động lại Nginx sau khi build lại.

Các đường dẫn quan trọng

• Dự án: /opt/mkdocs
• Nội dung: /opt/mkdocs/docs
• Cấu hình: /opt/mkdocs/mkdocs.yml
• Kết quả build: /opt/mkdocs/site
• Môi trường ảo Python: /opt/mkdocs/venv
• Tệp thực thi MkDocs: /opt/mkdocs/venv/bin/mkdocs
• Cấu hình Nginx: /etc/nginx/sites-available/mkdocs.conf

Tên miền và HTTPS

1. Trỏ tên miền của bạn tới địa chỉ IP của máy chủ.

2. Sửa cấu hình Nginx và thay server_name _; bằng tên miền của bạn (ví dụ, server_name <YOUR_DOMAIN>;):

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

3. Kiểm tra cấu hình:

nginx -t

4. Cài đặt Certbot:

apt install -y certbot python3-certbot-nginx

5. Tạo chứng chỉ Let's Encrypt:

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

6. Tải lại Nginx:

systemctl reload nginx

7. Cập nhật URL trang MkDocs: thay site_url: 'http://<SERVER_IP>/' bằng site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Build lại trang:

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

9. Mở trình duyệt và truy cập: https://<YOUR_DOMAIN>

Ghi chú

• Các thay đổi Markdown phải được build lại thì mới xuất hiện trên trang công khai.
• Nginx serves the generated files from /opt/mkdocs/site.
• Thay đổi mkdocs.yml và cấu hình dự án theo ý bạn.