Documentar seu projeto com wikis
Você pode usar um wiki para compartilhar informações longas e detalhadas sobre seu projeto.
Quem pode usar esse recurso?
Wikis estão disponíveis em repositórios públicos com o GitHub Free e o GitHub Free para organizações, e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server. Para mais informações, confira "Planos do GitHub".
Sobre wikis
Você pode hospedar a documentação para seu repositório em um wiki para que outras pessoas possam usar e contribuir com seu projeto.
Adicionar ou editar páginas de wiki
Você pode adicionar e editar páginas wiki diretamente no GitHub ou localmente usando a linha de comando.
Criar rodapé ou barra lateral na wiki
Você pode adicionar uma barra lateral ou um footer personalizado para seu wiki a fim de fornecer aos leitores informações mais contextuais.
Editar conteúdo de wiki
Você pode adicionar imagens e links no conteúdo do seu wiki e usar alguns formatos do MediaWiki compatíveis.
Exibir o histórico de alterações da wiki
Como wikis são repositórios do Git, cada alteração que você faz é um commit que pode ser exibido.
Alterar as permissões de acesso para wikis
Por padrão, somente os colaboradores de repositório podem editar o wiki de um repositório público, mas é possível permitir que qualquer pessoa com uma conta no GitHub.com faça isso.
Desabilitar wikis
É possível desabilitar wikis do repositório.