Versão do artigo: Enterprise Server 2.17
Adicionar ou editar páginas wiki
Você pode adicionar e editar páginas wiki diretamente no GitHub Enterprise ou localmente usando a linha de comando.
Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.
Adicionar páginas wiki
- No GitHub Enterprise, navegue até a página principal do repositório.
- Under your repository name, click Wiki.
- No canto superior direito da página, clique em New Page (Nova página).
- Se preferir escrever em um formato diferente do markdown, use o menu suspenso Edite mode (Editar modo) e clique em outro formato.
- Use o editor de texto para adicionar o conteúdo da página.
- Digite uma mensagem do commit descrevendo o novo arquivo que você está adicionando.
- Para fazer commit das alterações no wiki, clique em Save Page (Salvar página).
Editar páginas wiki
- No GitHub Enterprise, navegue até a página principal do repositório.
- Under your repository name, click Wiki.
- 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).
- Use o editor de texto para editar o conteúdo da página.
- Digite uma mensagem do commit descrevendo as alterações.
- 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. You can clone the repository to your computer with the provided URL:
$ 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.