• Repositório responsável por apresentar um projeto de documentação de dados, projetos e indicadores em Markdown, utilizando a ferramenta de documentação Mkdocs-Material.

A Material Design theme for MkDocs

Crie um site estático a partir de um conjunto de arquivos Markdown para hospedar a documentação de seu projeto comercial ou de código aberto – personalizável, pesquisável, compatível com dispositivos móveis, mais de 40 idiomas. Coisa rapida de configurar.

• Markdown ... — escreva sua documentação técnica em Markdown – não há necessidade de saber HTML, JavaScript ou CSS. Material para MkDocs fará o trabalho pesado levantamento e criação de um site bonito e funcional.

• ... mas há mais — integra-se nativamente ao Python Markdown Extensões, adição de textos explicativos, contêineres de conteúdo com guias, fórmulas matemáticas, marcação crítica, listas de tarefas e [mais de 10 mil ícones e emojis][icons-emojis].

• Responsivo por design — construído desde o início para funcionar em todos os tipos de dispositivos – de telefones celulares a widescreens. O layout fluido subjacente sempre se adaptam perfeitamente ao espaço de tela disponível.

• Estático, mas pesquisável — quase magicamente, sua documentação técnica site será pesquisável sem mais delongas. Material para MkDocs vem com pesquisa integrada – não é necessário servidor.

• Verdadeiramente internacional — graças a muitos colaboradores, Material for MkDocs inclui traduções para mais de 40 idiomas e oferece RTL nativo completo suporte (da direita para a esquerda).

• Arquitetura moderna — O material para a base de código subjacente do MkDocs é construído em cima de TypeScript, RxJS e SCSS, trazendo excelentes possibilidades para extensão e personalização do tema.

Requeriments:

• Pip;
• Ubuntu-20.14; => Não é obrigatório;
• VsCode; Também não é obrigatório, eu utilizo para realizar a programação;

Material for MkDocs can be installed with pip:

pip install mkdocs-material

Add the following line to mkdocs.yml:

theme:
  name: material

Recomendo para buscas e outras informações esse site aqui, muito bom, me ajudou muito. Mas você tambem pode pesquisar na internet, tem muita coisa dessa ferramenta na web. squidfunk.github.io/mkdocs-material

Copyright (c) 2021-2022 Wuldson Franco