menu

GitHub Pages

O GitHub Pages é um serviço que transforma arquivos Markdown em um site e os hospeda gratuitamente na internet.

Janela do aplicativo GitHub Pages!

Visão geral

Se você sabe usar o GitHub e precisa criar uma página da Web simples, uma boa opção é usar as páginas do GitHub. Basta criar um novo repositório, confirmar os arquivos do Markdown e ativar o recurso Páginas do GitHub.

O GitHub Pages usa o gerador de site estático Jekyll para criar seu site, e o suporte ao Markdown é excelente. Você pode escolher um dos temas pré-criados pelo próprio GitHub, usar um tema do Jekyll ou seu próprio CSS personalizado. Abaixo, é mostrada uma página da Web de exemplo usando um dos temas pré-criados pelo GitHub.

Vamos complicar um pouco, o GHP processa o Markdown de maneira diferente do próprio...GitHub. O GitHub usa seu próprio processador Markdown já o GitHub Pages, erh, usa o jekyll-commonmark. E o que isso significa? Bom, que seu arquivo README.md terá uma aparência diferente no site do GitHub e no site do GitHub Pages. Por exemplo, os emoticons são renderizados no site do GitHub, mas não nos sites gerados usando as páginas do GitHub.

Confuso?

Site: https://pages.github.com/

Suporte do Markdown no GitHub Pages

O GitHub Pages fornece suporte para os seguintes elementos Markdown.

Elemento Suporte Obs
Títulos Sim
Parágrafos Sim
Quebras de linha Sim
Negrito Sim
Itálico Sim
Bloco de citação Sim
Listas ordenadas Sim
Listas não ordenadas Sim
Código Sim
Linhas horizontais Sim
Links Sim
Imagens Sim
Tabelas Sim
Blocos de código cercado Sim O realce da sintaxe também é suportado. Certifique-se de que a opção syntax_highlighter: rouge esteja na seção kramdown do arquivo _config.yml
Notas de rodapé Sim
Id de títulos Sim
Listas de definições Sim
Riscado Sim Você pode usar dois tiles (~~palavra~~) ou um til (~palavra~) - ambos funcionam.
Listas de tarefas Sim
Emoji (copiar e colar) Desconhecido
Emoji (códigos de acesso) Desconhecido
Link automático de URL Sim
Desativar o link automático de URL Sim
HTML Sim

Suporte para elementos de sintaxe adicionais

O GitHub Pages também é compatível com alguns elementos obscuros.

Elemento Markdown Saída renderizada
Abreviação *[HTML]: Hyper Text Markup Language
A especificação do HTML é mantida pelo W3C.
A especificação do HTML é mantida pelo W3C

Veja também

Documentação do Jekyll

Documentação do kramdown