Skip to main content

Adicionar ou editar páginas de wiki

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

Os wikis estão disponíveis em repositórios internos e privados com GitHub AE. 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.

Adicionar páginas wiki

  1. On your enterprise, navigate to the main page of the repository. 1. No nome do repositório, clique em Wiki. Link do menu Wiki
  2. No canto superior direito da página, clique em Nova Página. Botão Nova Página do wiki
  3. 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
  4. Use o editor de texto para adicionar o conteúdo da página. WYSIWYG do wiki
  5. Digite uma mensagem do commit descrevendo o novo arquivo que você está adicionando. Mensagem do commit do wiki
  6. Para fazer commit das alterações no wiki, clique em Salvar Página.

Editar páginas wiki

  1. On your enterprise, navigate to the main page of the repository. 1. No nome do repositório, clique em Wiki. Link do menu Wiki
  2. Usando a barra lateral do wiki, navegue até a página que deseja alterar. No canto superior direito da página, clique em Excluir. Botão Editar página do wiki
  3. Use o editor de texto para editar o conteúdo da página. WYSIWYG do wiki
  4. Digite uma mensagem do commit descrevendo as alterações. Mensagem do commit do wiki
  5. Para fazer commit das alterações no wiki, clique em 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. Depois de criar uma página inicial no GitHub AE, você pode clonar o repositório em seu computador com a URL fornecida:

$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# Clones the wiki locally

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-padrão serão ativadas e disponibilizadas para os seus 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 marcação de código aberto para converter a marcação e determina o conversor que deve ser usado pela extensão de um arquivo. Por exemplo, se você der a um arquivo o nome foo.md ou foo.markdown, o wiki usará o conversor Markdown, enquanto um arquivo chamado foo.textile usará o conversor Textile.

Não use os seguintes caracteres nos títulos de páginas do 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.