MkDocs

Acesso

• Abra: http://SERVER_IP

Editar e publicar conteúdo

1. Adicione ou edite arquivos Markdown: /opt/mkdocs/docs

2. Se você adicionar ou renomear páginas, atualize /opt/mkdocs/mkdocs.yml for navigation.

3. Reconstrua o site:

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

O Nginx serve os arquivos gerados de: /opt/mkdocs/site

Não é necessário reiniciar o Nginx após reconstruir.

Caminhos importantes

• Projeto: /opt/mkdocs
• Conteúdo: /opt/mkdocs/docs
• Configuração: /opt/mkdocs/mkdocs.yml
• Saída do build: /opt/mkdocs/site
• Ambiente virtual do Python: /opt/mkdocs/venv
• Executável do MkDocs: /opt/mkdocs/venv/bin/mkdocs
• Configuração do Nginx: /etc/nginx/sites-available/mkdocs.conf

Domínio e HTTPS

1. Aponte seu domínio para o endereço IP do servidor.

2. Edite a configuração do Nginx e substitua server_name _; pelo seu domínio (por exemplo, server_name <YOUR_DOMAIN>;):

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

3. Teste a configuração:

nginx -t

4. Instale o Certbot:

apt install -y certbot python3-certbot-nginx

5. Gere um certificado Let's Encrypt:

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

6. Recarregue o Nginx:

systemctl reload nginx

7. Atualize a URL do site MkDocs: substitua site_url: 'http://<SERVER_IP>/' por site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Reconstrua o site:

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

9. Abra o seu browser e visite: https://<YOUR_DOMAIN>

Notas

• As mudanças em Markdown precisam ser reconstruídas antes de aparecerem no site público.
• Nginx serves the generated files from /opt/mkdocs/site.
• Altere mkdocs.yml e a configuração do projeto conforme suas preferências.