Wikis

Cada repositório pode hospedar uma wiki, uma coleção separada de páginas em Markdown para documentação que fica ao lado do código sem se misturar a ele.

Habilitar a wiki

Abra o repositório e selecione Configurações.
Em Recursos, ative Wiki.
Uma guia Wiki aparece na navegação do repositório.

Criar e editar páginas

Selecione a guia Wiki.
Se a wiki ainda não tiver páginas, selecione Create the First Page. Caso contrário, selecione New Page.
Informe um título para a página. O título se torna a URL da página, então escolha algo claro e estável.
Escreva o conteúdo em Markdown e depois selecione Save Page.

A primeira página que você criar se torna o Início da wiki, a página em que os visitantes chegam por padrão. Para atualizar uma página existente, abra-a e selecione Editar. Cada salvamento registra uma nova entrada no histórico de revisões da página.

Organizar a wiki

Duas páginas com nomes especiais controlam a navegação em toda a wiki:

_Sidebar: uma barra lateral personalizada exibida em todas as páginas. Adicione aqui links para as suas páginas mais importantes.
_Footer: um rodapé exibido na parte inferior de todas as páginas.

Crie qualquer uma delas em New Page usando exatamente o nome mostrado acima. Crie links entre páginas da wiki com Markdown padrão, referenciando o slug da página:

See the [Setup Guide](setup-guide) for installation steps.

Use títulos de página descritivos desde o início: o título se torna a URL, e renomear uma página depois quebra todos os links existentes para ela.

Editar a wiki localmente

A wiki é, ela mesma, um repositório Git, disponível na URL .wiki.git do seu repositório. Clone-a, edite os arquivos Markdown no seu editor e envie as alterações de volta.

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

O mesmo token de acesso pessoal que você usa no repositório principal funciona aqui. Cada arquivo Markdown se torna uma página da wiki; o nome do arquivo (sem a extensão .md) é o slug da página.