Todos os repositórios em your GitHub Enterprise Server instance são equipados com uma seção para a documentação de hospedagem denominada 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 obter mais informações, consulte "Sobre README".
Com wikis, é possível gravar conteúdo assim como em qualquer outro lugar no GitHub Enterprise Server. Para obter mais informações, consulte "Começando a escrever e formatar 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.
Se você criar um wiki em um repositório público, o wiki ficará disponível para qualquer pessoa com acesso para your GitHub Enterprise Server instance. Se você criar um wiki em um repositório privado ou interno, apenas as pessoas com acesso ao repositório poderão acessar o wiki. Para obter mais informações, consulte "Configurar visibilidade do repositório".
Você pode editar wikis diretamente no GitHub Enterprise Server 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 your GitHub Enterprise Server instance contribuam para um wiki em público. Para obter mais informações, consulte "Alterar permissões de acesso para wikis".
Observação: Os mecanismos de pesquisa não indexam o conteúdo de wikis. Para que seu conteúdo seja indexado por mecanismos de busca, você pode usar GitHub Pages em um repositório público.