Skip to main content

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.

Os wikis estão disponíveis em repositórios públicos com GitHub Free e 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 obter mais informações, confira "produtos de GitHub".

Todos os repositórios em GitHub.com 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, confira "Sobre os arquivos LEIAME".

Com wikis, é possível gravar conteúdo assim como em qualquer outro lugar no GitHub. Para obter mais informações, confira "Introdução à escrita e à formatação no GitHub". Usamos nossa biblioteca de marcação de código aberto para converter diferentes formatos em HTML, de modo que você possa optar por escrever seu aplicativo em Markdown ou em qualquer outro formato com suporte.

Você pode usar o Markdown para adicionar expressões matemáticas renderizadas, diagramas, mapas e modelos 3D ao wiki. Para obter mais informações sobre como criar expressões matemáticas renderizadas, confira "Escrever expressões matemáticas". Para obter mais informações sobre como criar diagramas, mapas e modelos 3D, confira "Criar diagramas".

Se você criar um wiki em um repositório público, o wiki estará disponível para o público. Se você criar um wiki em um repositório privado apenas as pessoas com acesso ao repositório poderão acessar o wiki. Para obter mais informações, confira "Como configurar a visibilidade do repositório".

Você pode editar wikis diretamente no GitHub 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 GitHub.com contribuam para um wiki em público. Para saber mais, confira "Como alterar as permissões de acesso para wikis".

Observação: os mecanismos de pesquisa não indexarão o conteúdo dos wikis. Para indexar seu conteúdo nos mecanismos de pesquisa, use o GitHub Pages em um repositório público.

Leitura adicional