Ir para o conteúdo

Banco de testes de conteúdo compartilhado

Esta seção foi incluída com o objetivo de verificar o conteúdo compartilhado fornecido por este repositório para uso no restante da documentação do BeeWare. “Conteúdo compartilhado” refere-se a documentos ou seções de documentos que são comuns a vários outros repositórios. Eles são armazenados aqui para inclusão nesses repositórios. Isso significa que há uma única fonte quando são necessárias atualizações, e que a alteração será aplicada em todos os repositórios que utilizam esse conteúdo compartilhado.

Se você estiver atualizando conteúdo existente, as etapas a seguir não são necessárias. Basta criar o site de teste e ver suas atualizações renderizadas.

Se você estiver criando um novo arquivo de documentação compartilhada no diretório shared-content, que NÃO deve ser incluído no diretório how-to, faça o seguinte:

  1. Crie um arquivo no content_test_bed com o mesmo nome do seu novo arquivo de conteúdo, acrescentando “_include” no final.
    • Para style_guide.md, você adicionaria style_guide_include.md.
  2. Usando a sintaxe Snippets, adicione o nome do arquivo a filename_include.md. A sintaxe Snippets para incluir conteúdo é -8<- "filename.md".
    • Para style_guide.md, você adicionaria -8<- "style_guide.md" a style_guide_include.md.
  3. Atualize a seção Shared content test bed em /docs/SUMMARY.md para incluir o novo arquivo _include e caminho, no mesmo nível de indentação que os outros itens nessa seção.
    • Para style_guide_include.md, você adicionaria - [Style guide](content_test_bed/style_guide_include.md).

Depois de concluir essas etapas, você poderá criar o site de teste e visualizar sua nova documentação renderizada.