Introdução ao GitHub Wiki
A utilização de wikis em repositórios do GitHub é uma das formas de compartilhar e colaborar em documentação de projetos.
Importante
A disponibilidade das wikis varia conforme o plano do GitHub escolhido, sendo acessíveis em repositórios públicos com GitHub Free e GitHub Free para organizações, além de repositórios públicos e privados em planos como GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server.
A aba Wiki em cada repositório permite compartilhar informações mais detalhadas sobre o projeto, como seu funcionamento, design e princípios/objetivos, complementando o resumo fornecido pelo arquivo README.md. A flexibilidade da linguagem Markdown permite incluir expressões matemáticas renderizadas com LaTex, diagramas com a Mermaid, mapas com GeoJSON e TOPO JSON e modelos 3D com ASCII STL na documentação da wiki.
Se uma wiki for criado em um repositório público, estará acessível ao público; se criado em um repositório privado, apenas as pessoas com acesso ao repositório poderão visualizá-lo.
É possível editar wikis no GitHub ou localmente. A edição padrão requer a permissão de gravação ao repositório, mas é possível permitir contribuições públicas em wikis.
Nota
As motores de busca indexarão apenas wikis com 500 ou mais estrelas, a menos que se configure para evitar a edição pública. Para garantir que o conteúdo seja indexado, sugere-se o uso do GitHub Pages em um repositório público.