Gerador de sites estáticos em Rust para documentação em Markdown, criado pela equipe por trás do Material for MkDocs.
6 mil134RustMITAtualizado há 3 dias
squidfunk/mkdocs-material
Um tema Material Design para MkDocs que transforma arquivos Markdown em um site estático de documentação responsivo e pesquisável.
- Estrelas
- 27,581
- Forks
- 4,150
- Issues abertas
- 1
- Último commit
- há 5 dias
O que é?
Material for MkDocs é um tema para MkDocs, um gerador de sites estáticos para documentação de projetos escrita em Markdown. Ele usa arquivos Markdown como fonte e gera um site estilizado com navegação, busca e layouts que se adaptam a telas de desktop, tablet e celular. A instalação é feita por um pacote pip, e o tema é ativado com algumas linhas no mkdocs.yml.
O tema pode ser configurado sem escrever HTML, CSS ou JavaScript. Cores, fontes, ícones, logotipo e idioma da interface (mais de 60 idiomas) são definidos pela configuração, e o projeto oferece pontos de extensão para personalizações adicionais. O site é gerado como arquivos estáticos, então a saída pode ser hospedada em qualquer serviço de hospedagem estática, e o conteúdo original e o gerado ficam sob o controle de quem mantém o projeto.
O projeto usa a licença MIT e é desenvolvido em Python. Vários projetos de código aberto e empresas usam o tema em seus sites de documentação.
Recursos principais
- 01Escreva a documentação em Markdown sem precisar de HTML, CSS ou JavaScript.
- 02Layout responsivo que se adapta a telas de desktop, tablet e celular.
- 03Busca e navegação integradas para sites estáticos gerados.
- 04Personalize cores, fontes, ícones, logotipo e idioma pela configuração.
- 05Oferece suporte a mais de 60 idiomas de interface.
Casos de uso
- Criar um site de documentação para uma biblioteca ou ferramenta de código aberto.
- Publicar documentação interna de produto ou engenharia para uma empresa.
- Criar um site de documentação multilíngue com design consistente.
Início rápido
- 1
Instale o Material for MkDocs com pip
pip install mkdocs-material - 2
Adicione o tema ao mkdocs.yml
theme: name: material
Antes de usar
- Requer Python e a cadeia de ferramentas do MkDocs, portanto só é útil para sites de documentação.
Tópicos
Perguntas frequentes
- O que é mkdocs-material?
- Um tema Material Design para MkDocs que transforma arquivos Markdown em um site estático de documentação responsivo e pesquisável. Material for MkDocs é um tema para MkDocs, um gerador de sites estáticos para documentação de projetos escrita em Markdown. Ele usa arquivos Markdown como fonte e gera um site estilizado com navegação, busca e layouts que se adaptam a telas de desktop, tablet e celular. A instalação é feita por um pacote pip, e o tema é ativado com algumas linhas no mkdocs.yml.
- mkdocs-material é gratuito? Qual é a licença?
- mkdocs-material é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- mkdocs-material ainda é mantido?
- Manutenção ativa. O último commit de mkdocs-material foi em 17 de out. de 2026.
- Para que posso usar mkdocs-material?
- Criar um site de documentação para uma biblioteca ou ferramenta de código aberto. Publicar documentação interna de produto ou engenharia para uma empresa. Criar um site de documentação multilíngue com design consistente.
- Como instalar mkdocs-material?
- Instale o Material for MkDocs com pip: pip install mkdocs-material Adicione o tema ao mkdocs.yml: theme: name: material
- Onde consigo mkdocs-material?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/squidfunk/mkdocs-material
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Tema Hugo para criar sites de documentação técnica, mantido no âmbito da Linux Foundation.
3 mil985JavaScriptApache-2.0Atualizado há 9 horas
Um gerador de sites de documentação que transforma arquivos Markdown em um site sem exigir uma etapa de build.
31,6 mil5,8 milJavaScriptMITAtualizado ontem
Ferramenta de linha de comando em Rust que cria livros online a partir de arquivos Markdown, semelhante ao GitBook.
22,2 mil1,9 milRustMPL-2.0Atualizado há 18 horas
Um scaffolder que gera no seu repositório um site de documentação Astro editável, com Markdown legível por agentes e saída llms.txt incluídos.
1,4 mil52TypeScriptMITAtualizado há 3 dias
Engine open source de renderização com Next.js que serve sites de documentação publicados no GitBook, com opção de hospedagem própria.
29,1 mil4 milTypeScriptGPL-3.0Atualizado há 21 horas