⚡ Cap 15: SSGs Modernos para Documentação - Exemplos Práticos
Demonstrações práticas de configurações e componentes modernos com Docusaurus (MDX) e VitePress.
🗺️ Comparativo de Desempenho e Recursos dos SSGs
flowchart TD
subgraph SSG_MATRIX ["Matriz de Escolha de SSG para Documentação"]
J["Jekyll: Simplicidade histórica, zero build no GitHub Pages"]
M["MkDocs Material: Ideal para equipes Python, CLI rápida e busca embutida"]
D["Docusaurus: Gigantes corporativos, versionamento v1/v2, MDX completo"]
V["VitePress: SPA veloz com Vue 3 e suporte a Vite HMR"]
A["Astro Starlight: Zero JavaScript no cliente, performance máxima ⚡"]
end
style J fill:#ede7f6,stroke:#512da8,stroke-width:1.5px
style M fill:#fff9c4,stroke:#fbc02d,stroke-width:1.5px
style D fill:#e1f5fe,stroke:#03a9f4,stroke-width:1.5px
style V fill:#e8f5e9,stroke:#4caf50,stroke-width:1.5px
style A fill:#00897b,stroke:#004d40,stroke-width:2px,color:#ffffff
📄 Exemplo 1: Configuração do VitePress (.vitepress/config.js)
export default {
title: 'VitePress Docs',
description: 'Documentação ultrarrápida gerada com Vue 3 e Vite',
themeConfig: {
nav: [
{ text: 'Guia', link: '/guia/' },
{ text: 'API', link: '/api/' },
{ text: 'Changelog', link: 'https://github.com/empresa/repo/releases' }
],
sidebar: {
'/guia/': [
{
text: 'Introdução',
items: [
{ text: 'O que é o Framework?', link: '/guia/o-que-e' },
{ text: 'Primeiros Passos', link: '/guia/primeiros-passos' }
]
}
]
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/empresa/repo' }
],
search: {
provider: 'local'
}
}
}
📄 Exemplo 2: Admonitions Avançados do MkDocs Material
!!! note "Nota Importante"
Esta funcionalidade requer a versão 3.12 ou superior do Python.
!!! tip "Dica de Performance"
Utilize conexões com pooling no PostgreSQL para suportar alta concorrência.
!!! warning "Aviso de Depreciação"
O endpoint `/v1/auth/legacy` será desligado definitivamente em Dezembro de 2026.