Sobre wikis

Cada repositório do GitHub é equipado com uma seção para hospedar documentação, chamada de 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 LEIAME informa rapidamente o que seu projeto pode fazer, enquanto você pode usar um wiki para fornecer documentação adicional. Para obter mais informações, consulte "Sobre LEIAME".

Com wikis, é possível gravar conteúdo assim como em qualquer outro lugar no GitHub. Para obter mais informações, consulte "Introdução à gravação e formatação no GitHub". Usamos nossa biblioteca de markup de código aberto para converter diferentes formatos em HTML, de modo que seja possível optar por escrever em markdown ou qualquer outro formato compatível.

Os wikis estão disponíveis para o público em repositórios públicos e limitados a pessoas com acesso ao repositório em repositórios privados. Para obter mais informações, consulte "Configurar visibilidade do repositório".

Você pode editar wikis diretamente no GitHub ou editar arquivos wiki localmente. Por padrão, somente pessoas com acesso de gravação ao seu repositório podem fazer alterações nos wikis, embora você possa permitir que todos no GitHub contribuam com um wiki em um repositório público. Para obter mais informações, consulte "Alterar permissões de acesso para wikis".

Further reading

• "Adicionar ou editar páginas wiki"
• "Criar um footer ou uma barra lateral para seu wiki"
• "Editar conteúdo do wiki"
• "Exibir histórico de alterações de um wiki"
• "Pesquisar wikis"