Introdução ao MkDocs Material

📚 Bem-vindo ao MkDocs Material! 📚

O MkDocs Material é um tema elegante e poderoso para documentar seus projetos em Markdown. Vamos ver como instalá-lo e configurá-lo em poucos passos.

🛠️ 1. Instalação

No seu terminal, crie um ambiente virtual e instale as dependências:

python -m venv .venv
source .venv/bin/activate      # Linux/macOS
# .venv\Scripts\activate       # Windows PowerShell
pip install mkdocs mkdocs-material

📑 2. mkdocs.yml Mínimo

Crie um arquivo mkdocs.yml na raiz do projeto:

site_name: Meu Projeto
theme:
  name: material
nav:
  - Home: index.md

Em seguida, crie o docs/index.md:

# Olá, MkDocs Material!

Este é seu novo site de documentação, pronto para ser customizado.

🎨 3. Customizando com extra.css

Para ajustar cores, fontes ou layout, adicione um CSS extra:

Crie a pasta docs/assets/stylesheets/
Dentro dela, crie extra.css e coloque, por exemplo:

   /* altera a cor do header */
   .md-header {
     background-color: #1A4568;
   }
   /* centraliza títulos */
   .md-content h1 {
     text-align: center;
   }

No mkdocs.yml, referencie o CSS:

   extra_css:
     - assets/stylesheets/extra.css

🚀 4. Rodando o servidor

Basta executar:

mkdocs serve

Abra http://127.0.0.1:8000/ no navegador e veja sua doc ao vivo!

✨ Agora você já tem o MkDocs Material instalado, configurado e pronto para personalizar sua documentação com estilo. Boas escritas! ✨