Wikis

Cada repositório pode alojar uma wiki — uma coleção separada de páginas Markdown para documentação que vive junto ao código sem se misturar com ele.

Ativar a wiki

Abra o repositório e selecione Definições.
Em Caraterísticas, ative Wiki.
Surge um separador Wiki na navegação do repositório.

Criar e editar páginas

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

A primeira página que criar passa a ser o Início da wiki — a página onde os visitantes aterram por predefinição. Para atualizar uma página existente, abra-a e selecione Editar. Cada gravação regista 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 apresentada em todas as páginas. Adicione aqui ligações para as suas páginas mais importantes.
_Footer — um rodapé apresentado no fim de todas as páginas.

Crie qualquer uma delas a partir de New Page com o nome exato indicado acima. Ligue páginas da wiki entre si com Markdown padrão, referenciando o slug da página:

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

Utilize títulos de página descritivos desde o início: o título passa a ser o URL e mudar o nome de uma página mais tarde quebra as ligações existentes para ela.

Editar a wiki localmente

A wiki é, ela própria, um repositório Git, disponível no URL .wiki.git do seu repositório. Clone-a, edite os ficheiros 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 utiliza para o repositório principal funciona aqui. Cada ficheiro Markdown torna-se uma página da wiki; o nome do ficheiro (sem a extensão .md) é o slug da página.