📍 O que é MkDocs
O que é MkDocs?¶
O MkDocs é um gerador de site estático para documentação simples, rápido e bonito para seu projeto. Ele é feito em Python, então já entendemos a origem da sua simplicidade, mas não confunda simplicidade com falta de recursos, porque o MkDocs tem muitos recursos que você pode usar com poucas linhas de código. A documentação é escrita em Markdown, que é uma forma de escrever HTML bem mais simples e bonita e a configuração do MkDocs é feita em apenas um arquivo YAML.
Quando ocorre o build, o MKDocs vai gerar arquivos estáticos (HTML, CSS e JS), com isso você pode hospedar o site da sua documentação sem pagar nada no GitHub ou GitLab, porque esses serviços possuem os recursos GitHub Pages e GitLab Pages, respectivamente, que permitem a utilização dos arquivos estáticos.
O MkDocs ainda possui um servidor de desenvolvimento integrado, isso permite pré-visualizar a documentação à medida que a escreve. Ele também vai recarregar automaticamente e atualizar seu navegador sempre que você salvar suas alterações.
O que Mkdocs Material oferece mais¶
É só Markdown¶
Concentre-se no conteúdo de sua documentação e crie um site estático profissional em minutos. Não há necessidade de saber HTML, CSS ou JavaScript – deixe o Material for MkDocs fazer o trabalho pesado para você.
Funciona em todos os dispositivos¶
Sirva sua documentação com confiança – o Material for MkDocs se adapta automaticamente para caber perfeitamente na tela disponível, independentemente do tipo ou tamanho do dispositivo de visualização. Área de Trabalho. Tábua. Móvel. Tudo ótimo.
Feito para medir¶
Torne-o seu - altere as cores, fontes, idioma, ícones, logotipo e muito mais com algumas linhas de configuração. Material para MkDocs pode ser facilmente estendido e oferece muitas opções para alterar a aparência e o comportamento.
Rápido e leve¶
Não deixe seus usuários esperarem – obtenha um valor incrível com uma pegada pequena usando um dos temas mais rápidos disponíveis com excelente desempenho, produzindo classificações de mecanismo de pesquisa ideais e usuários satisfeitos que retornam.
Construído para todos¶
Faça da acessibilidade uma prioridade – os usuários podem navegar em sua documentação com dispositivos de toque, teclados e leitores de tela. A marcação semântica garante que sua documentação funcione para todos.
Código aberto¶
Confie em mais de 20.000 usuários - escolha uma solução madura e mantida ativamente, construída com tecnologias Open Source de última geração. Mantenha a propriedade do seu conteúdo sem medo do bloqueio do fornecedor. Licenciado pelo MIT.
Para saber mais visite o site oficial Mkdocs Material.
Created: April 23, 2023