GitHub Pages
O GitHub Pages é um serviço da Web que permite que o usuário hospede um site gratuitamente criado a partir de arquivos Markdown.
Visão geral
Se você já tem experiência com o GitHub e precisa hospedar um site na internet, você pode usar diretamente o serviço de armazenamento GitHub Pages.
Vale ressaltar que as páginas hospedadas no GitHub Pages são páginas simples, como páginas em HTML, não existe servidor para você rodar PHP, Python ou Ruby e nem Banco de dados.
Para hospedar um site basta criar um novo repositório, inserir os seus arquivos formatados em Markdown e ativar o recurso do GitHub Pages.
O GitHub Pages é uma das ferramentas com maior compatibilidade com o Markdown utilizando como base o gerador de sites estático Jekyll.
A ferramenta oferece, ainda, temas que o usuário pode escolher para compor o seu site.
Claro que você pode criar um site e formatá-lo usando o seu próprio CSS.
Abaixo, você confere uma página da Web construída com um dos temas oferecido pelo GitHub Pages.
Só como curiosidade, o GitHub Pages e o GitHub utilizam processadores Markdown diferentes. O GitHub possui um processador Markdown próprio enquanto o GitHub Pages usa o jekyll-commonmark.
Com essa diferença entre os processadores Markdown, algumas formatações podem aparecer de formas diferente no seu arquivo README.md.
O mais notório seria o uso de emoticons, no site do GitHub seria renderizado e no site gerado pelo GitHub Pages não.
https://pages.github.com/ é o site oficial do GitHub Pages.
Suporte ao Markdown no GitHub Pages
Na Tabela 1.1 são apresentados os elementos Markdown compatíveis com o GitHub Pages.
| Elemento | Suporte | Informação |
|---|---|---|
| Títulos | Sim | |
| Parágrafos | Sim | |
| Quebras de linha | Sim | |
| Negrito | Sim | |
| Itálico | Sim | |
| Blockquote | 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 | Você consegue realçar o código do bloco, mas para isso é necessário verificar se a opção syntax_highlighter: rouge se encontra dentro do arquivo de configuração _config.yml, essa opção fica localizada na seção kramdown. |
| Notas de rodapé | Sim | |
| Id de títulos | Sim | |
| Listas de definições | Sim | |
| Tachado | Sim | O GitHub Pages fornece suporte as sintaxes com dois tiles ~~palavra~~ ou apenas um til ~palavra~, ambas 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
A Tabela 1.2 mostra elementos não tão familiares aos usuários do Markdown que possuem suporte no GitHub Pages.
| Elemento | Markdown | Saída |
|---|---|---|
| Abreviação | *[HTML]: Hyper Text Markup LanguageA especificação do HTML é mantida pelo W3C. |
A especificação do HTML é mantida pelo W3C |