Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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.

Wikis are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

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

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato