Inicializando Servidor

Configurando mkdocs material

Por padrão dentro do arquivo mkdocs.yml não vem na estrutura que precisamos então teremos que adicionar algumas informações, fique calmo porque é bem simples é só deixar como o exemplo a seguir.

Warning

É muito importante respeitar os espaço que tem na estrutura.

Arquivo .yml

Estrutura padrão do arquivo mkdocs.ymlEstrutura como deve ser arquivo mkdocs.yml

site_name: My Docs

site_name: My Docs

nav:
  - Index: index.md

theme:
  name: 'material'

Inicializando o servidor

Vamos inicializar o servidor do MkDocs para verificar como está a nossa documentação teste que foi criada até agora.

Lembre-se de estar no mesmo diretório que o arquivo de configuração mkdocs.yml no seu prompt ananconda, digite o comando a seguir.

Iniciando o serve

serve

mkdocs serve

Abra o seu navegador e digite a seguinte URL http://localhost:8000/, encontrará uma página igual ou semelhante a essa:

---

Last update: July 2, 2023
Created: June 25, 2023