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.

Adicionar ou editar páginas wiki

Você pode adicionar e editar páginas wiki diretamente no GitHub ou localmente usando a linha de comando.

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."

Neste artigo

Adicionar páginas wiki

  1. No GitHub, navegue até a página principal do repositório.

  2. Under your repository name, click Wiki.

    Wiki menu link

  3. No canto superior direito da página, clique em New Page (Nova página).

    Botão Wiki new page (Nova página wiki)

  4. Se preferir escrever em um formato diferente do markdown, use o menu suspenso Edite mode (Editar modo) e clique em outro formato.

    Seleção de markup do wiki

  5. Use o editor de texto para adicionar o conteúdo da página.

    WYSIWYG do wiki

  6. Digite uma mensagem do commit descrevendo o novo arquivo que você está adicionando.

    Mensagem do commit do wiki

  7. Para fazer commit das alterações no wiki, clique em Save Page (Salvar página).

Editar páginas wiki

  1. No GitHub, navegue até a página principal do repositório.

  2. Under your repository name, click Wiki.

    Wiki menu link

  3. Usando a barra lateral do wiki, navegue até a página que deseja alterar. No canto superior direito da página, clique em Edit (Editar).

    Botão Wiki edit page (Editar página wiki)

  4. Use o editor de texto para editar o conteúdo da página.

    WYSIWYG do wiki

  5. Digite uma mensagem do commit descrevendo as alterações.

    Mensagem do commit do wiki

  6. Para fazer commit das alterações no wiki, clique em Save Page (Salvar página).

Adicionar ou editar páginas wiki localmente

Os wikis fazem parte dos repositórios Git, de modo que é possível fazer alterações localmente e fazer push delas no seu repositório usando o fluxo de trabalho Git.

Clonar wikis para seu computador

Cada wiki fornece uma maneira fácil de clonar o respectivo conteúdo para seu computador.

A URL de clonagem do wiki

Se estiver usando o GitHub Desktop, clique em Clone in Desktop (Clonar no Desktop) para copiar o wiki no seu computador.

Caso contrário, você pode clonar o repositório no seu computador com a URL fornecida.

$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# Clona o wiki localmente

Depois de clonar o wiki, é possível adicionar novos arquivos, editar os existentes e fazer commit das alterações. Você e seus colaboradores podem criar branches ao trabalhar em wikis, mas somente as alterações enviadas por push ao branch master serão ativadas e disponibilizadas aos leitores.

Sobre nomes de arquivo de wiki

O nome de arquivo determina o título da sua página wiki e a extensão do arquivo determina como o conteúdo do wiki será renderizado.

Os wikis usam nossa biblioteca de markup de código aberto para converter o markup e determinam qual conversor usar pela extensão de um arquivo. Por exemplo, se o nome de um arquivo for foo.md ou foo.markdown, o wiki usará o conversor Markdown, enquanto em um arquivo chamado foo.textile, ele usará o conversor Textile.

Não use os seguintes caracteres nos títulos da sua página wiki: \ / : * ? " < > |. Os usuários em determinados sistemas operacionais não poderão trabalhar com nomes de arquivo contendo esses caracteres. Certifique-se de escrever seu conteúdo usando uma linguagem markup que corresponda à extensão, ou o conteúdo não será renderizado adequadamente.

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato