Pular para conteúdo

Setup MkDocs Local 🚀

Embora você possa escrever Markdown em qualquer lugar, rodar o MkDocs localmente permite que você veja exatamente como o site final ficará antes de enviá-lo para o GitHub.

1. Pré-requisitos 🐍

Para rodar o MkDocs, você precisa do Python instalado em sua máquina. - Baixe em: python.org

2. Instalação das Dependências 📦

Abra o terminal na pasta do projeto e execute:

pip install -r requirements.txt

(Isso instalará o MkDocs, o tema Material e todos os plugins de diagramas e slides usados no curso).

3. Rodando o Servidor 🌐

Para visualizar o site localmente, execute o comando:

mkdocs serve

O terminal informará um endereço (geralmente http://127.0.0.1:8000/). Copie e cole no seu navegador. Qualquer alteração que você fizer nos arquivos .md será refletida instantaneamente!

4. Gerando a Versão Final 🏗️

Quando estiver pronto para gerar os arquivos HTML estáticos:

mkdocs build
Os arquivos serão gerados na pasta site/.