Construa sites de documentação técnica versionados com pesquisa e navegação usando Material for MkDocs
Use o Material for MkDocs para transformar a documentação em Markdown em um site estático pesquisável e navegável com configuração pronta para projetos e visualizações.
Pré-requisitos
Python, pip ou Docker, MkDocs, Material for MkDocs, arquivos de documentação Markdown
Instalação
Siga o caminho de instalação oficial ou configuração que corresponda ao seu ambiente:
- Torne-o seu – altere cores, fontes, idioma, ícones, logotipo e muito mais com
- pip install mkdocs-material
Requisitos e observações da fonte oficial:
- alt="Índice do Pacote Python"
- <img
- src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
Notas de uso básico ou primeiros passos:
-
O Material for MkDocs pode ser instalado com pip:
-
sh
-
Adicione as seguintes linhas ao mkdocs.yml:
-
Extraído da documentação oficial: https://raw.githubusercontent.com/squidfunk/mkdocs-material/HEAD/README.md