Cada repositório em GitHub vem equipado com uma seção para hospedar documentação, chamada wiki. Você pode usar o wiki do repositório para compartilhar conteúdo longo sobre seu projeto, por exemplo, como usá-lo, como ele foi projetado ou seus princípios básicos. Um arquivo README informa rapidamente o que seu projeto pode fazer, enquanto você pode usar um wiki para fornecer documentação adicional. Para saber mais, confira Sobre LEIAMEs.
Com as wikis, é possível gravar conteúdo, assim como em qualquer outro lugar no GitHub. Para saber mais, confira Introdução à escrita e formatação no GitHub. Usamos nossa biblioteca de marcação de código aberto para converter diferentes formatos em HTML, de modo que você possa optar por escrever seu aplicativo em Markdown ou em qualquer outro formato com suporte.
Você pode usar o Markdown para adicionar expressões matemáticas renderizadas, diagramas, mapas e modelos 3D ao wiki. Para obter mais informações sobre como criar expressões matemáticas renderizadas, confira "Como escrever expressões matemáticas". Para obter mais informações sobre como criar diagramas, mapas e modelos 3D, confira "Criando diagramas".
Se você criar um wiki em um repositório público, o wiki estará disponível para o público. Se você criar uma wiki em um repositório privado, somente as pessoas com acesso ao repositório poderão acessar a wiki. Para saber mais, confira Definir a visibilidade do repositório.
Você pode editar wikis diretamente no GitHub ou editar arquivos wiki localmente. Por padrão, somente as pessoas com acesso de gravação ao repositório podem fazer alterações no wikis, embora você possa permitir que todos em GitHub.com contribuam para uma wiki em um repositório público. Para saber mais, confira Alterar as permissões de acesso para wikis.
Note
Os mecanismos de pesquisa indexarão apenas wikis com 500 ou mais estrelas configuradas para impedir a edição pública. Para saber mais, confira Alterar as permissões de acesso para wikis.
Caso precise que os mecanismos de pesquisa indexem o conteúdo, use o GitHub Pages em um repositório público. Para saber mais, confira GitHub Pages.
Note
Por motivos de desempenho, as wikis têm um limite flexível de 5.000 arquivos no total, independentemente do tipo de arquivo. Se você exceder esse limite, talvez os usuários não consigam acessar algumas páginas. Se você precisar de um wiki maior, recomendamos usar o GitHub Pages. Para saber mais, confira GitHub Pages.