Demonstração das ferramentas do Docs¶
Lista de verificação do tema¶
Esta demonstração foi concebida para testar as várias funcionalidades das substituições do tema BeeWare MkDocs Material. Leia atentamente e verifique se tudo o que está listado nesta página e nas páginas seguintes está presente e a funcionar conforme descrito.
Barra de título¶
Uma barra de título cinza médio está na página. Isso significa que o modelo do tema foi aplicado.
Ícone do cabeçalho¶
O ícone do cabeçalho no canto superior esquerdo foi renderizado. Isso confirma que o modelo pode fazer referência a recursos externos.
Ícone da barra lateral da página inicial¶
O ícone do logotipo na barra lateral esquerda foi renderizado. O logotipo deve ter a largura e a altura iguais às da barra lateral. O título do site deve ser renderizado abaixo dele em uma fonte ligeiramente maior do que o resto da barra lateral, com o número da versão abaixo dele em uma fonte menor.
Isso confirma que a barra lateral será exibida corretamente nos sites de destino.
Fonte do título¶
Os títulos são apresentados em Cutive. Isso confirma que o tema CSS personalizado do BeeWare foi aplicado.
Código embutido¶
O código inline é renderizado na mesma cor da fonte circundante. Isso confirma que o tema não causou nenhuma alteração indesejada.
Este é um texto com inline code aqui e inline code aqui.
Código de conteúdo com abas¶
O código está em uma cor contrastante com o fundo. O botão Copiar deve copiar apenas os comandos; o prompt não deve ser incluído.
Isso confirma que o tema não causou nenhuma alteração indesejada, bem como se o botão copiar está funcionando conforme o esperado.
$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git
Comportamento do botão Copiar código¶
O botão copiar no seguinte bloco de código deve resultar na cópia de from
pathlib import Path para a área de transferência.
from pathlib import Path
O botão Copiar no bloco de código a seguir deve resultar na cópia de ls
beeware-docs-tools para a área de transferência. O prompt do shell e a saída
não devem ser incluídos.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Links da barra lateral¶
Os links da barra lateral existem e apontam para o repositório
beeware-docs-tools. Isso confirma que o conteúdo da barra lateral foi
carregado, que project-name foi definido no arquivo de configuração do MkDocs
e que o número da versão foi calculado e adicionado.
Cores dos links¶
Este link para o site principal da BeeWare deve ser azul tanto no modo claro quanto no modo escuro.
Os links nas barras laterais esquerda e direita também devem ser azuis em ambos os modos.
Ao rolar a página para baixo, o link do cabeçalho ativo na barra lateral direita deve ser azul claro no modo escuro e azul mais escuro no modo claro.
Advertência sobre tradução¶
A versão em inglês deste documento deve exibir a advertência “Traduções disponíveis” abaixo. A tradução em francês deve exibir a advertência “Esta é uma tradução automática!”. A tradução em alemão deve exibir a advertência “Esta é uma tradução!” para traduções feitas por humanos.
Esta é uma tradução automática!
Esta versão do tutorial foi gerada por tradução automática. Sabemos que não é o ideal, mas consideramos que uma tradução ruim é melhor do que nenhuma tradução.
Página 404 personalizada¶
Adicione nopage ao final da URL no seu navegador para verificar se a página
404 existe e inclui o texto “Brutus não consegue encontrar o que você está
procurando”. A página 404 atual nem sempre exibe as imagens devido a um problema
com o MkDocs.
O MkDocs falha na compilação com links internos não reconhecidos, portanto, você precisa verificar manualmente essa verificação modificando a URL no seu navegador.
Próximas verificações¶
O link a seguir deve levá-lo à Seção Um da Demonstração das Ferramentas da BeeWare Docs. Ele foi incluído para verificar os links entre páginas.
Navegue até BeeWare Docs Ferramentas Demonstração Seção Um para as próximas verificações.