Editar conteúdo de wiki

Você pode adicionar imagens e links no conteúdo do seu wiki e usar alguns formatos do MediaWiki compatíveis.

Quem pode usar esse recurso?

Wikis estão disponíveis em repositórios públicos com o GitHub Free e o 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. Para saber mais, confira Planos do GitHub.

Neste artigo

Você pode criar links em wikis usando um dos formatos a seguir. Por exemplo:

  • Se as suas páginas forem renderizadas com Markdown, a sintaxe do link será [Link Text](full-URL-of-wiki-page).
  • Com a sintaxe MediaWiki, a sintaxe do link é [[Nameofwikipage|Link Text]].

Adição de imagens

Os wikis podem exibir imagens em PNG, JPEG e GIF.

  1. Em GitHub, acesse a página principal do repositório.

  2. No nome do repositório, clique em Wiki.

    Captura de tela do menu em um repositório. A opção "Wiki" está contornada em laranja escuro.

  3. Usando a barra lateral do wiki, navegue até a página que deseja alterar e clique em Editar.

  4. Na barra de ferramentas do wiki, clique em .

    Captura de tela da barra de ferramentas na página de edição do wiki. O ícone para adicionar uma imagem é contornado em laranja escuro.

  5. Na caixa de diálogo "Insert Image" (Inserir imagem), digite a URL da imagem e o texto alt (que é usado por mecanismos de pesquisa e leitores de tela).

  6. Clique em OK.

Vincular a imagens em um repositório

Para vincular a uma imagem em um repositório no GitHub, copie a URL no navegador e use-a como caminho para a imagem. Por exemplo, a incorporação de uma imagem no wiki usando Markdown pode ter esta aparência:

[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]

Adicionar expressões matemáticas e diagramas

Você pode usar o Markdown para adicionar expressões matemáticas renderizadas, diagramas, mapas e modelos 3D ao wiki. Para saber mais sobre como criar expressões matemáticas renderizadas, confira Como escrever expressões matemáticas. Para saber mais sobre como criar diagramas, mapas e modelos 3D, confira Criando diagramas.

Formatos do MediaWiki compatíveis

Seja qual for a linguagem de marcação em que sua página wiki foi escrita, sempre haverá uma sintaxe do MediaWiki disponível para você.

  • Regras horizontais por meio de ---
  • Entidades de símbolo de abreviação (como δ ou €)

Por motivos de segurança e desempenho, algumas sintaxes não são compatíveis.