Guía Markdown de GitHub Pages

GitHub Pages genera sitios web estáticos a partir de tus archivos Markdown.

GitHub Pages es un servicio de GitHub que generará un sitio web estático a partir de tus archivos Markdown.

Acerca de GitHub Pages

Con GitHub Pages pdorás crear una web estática directamente desde GitHub. Es un servicio ideal para crear y publicar la documentación de tus proyectos. GitHub Pages usa Jekyll, por lo que el soporte de Markdown es excelente.

Imagen de GItHub Pages

Podrás seleccionar entre una amplia variedad de temas, aunque también podrás usar cualquier tema de Jekyll, crear tu propio tema o personalizar el código CSS.

Dado que GitHub pages usa Jekyll, el modo en el que la sintaxis Markdown es renderizada varía con respecto al modo en el que se renderiza el GitHub. Esto es debido a que GitHub Pages usa la sintaxis jekyll-commonmark-ghpages, mientras que GitHub usa por defecto Github Flavored Markdown. Esto conlleva ciertos cambios, ya que por ejemplo no podrás usar shortcodes para los emojis en GitHub Pages.

Además de los sitios generados con Jekyll, también podrás publicar cualquier web generada de forma estática en GitHub Pages. Por ejemplo, puedes publicar aplicaciones aplicaciones Vue o aplicaciones que usen React, aunque tendrás que generar los sitios localmente antes de publicarlos.

Soporte Markdown

La compatibilidad de GitHub Pages con Markdown es excelente, soportando todos los elementos de la sintaxis básica de Markdown y casi todos los elementos de la sintaxis extendida. A continuación puedes ver la tabla de compatibilidad de GitHub Pages con Markdown:

Soporte adicional

GitHub Pages, al igual que Jekyll, también soporta ciertos elementos adicionales que no se enmarcan dentro de la sintaxis habitual de Markdown, como por ejemplo las abrevitaturas:

ElementoMarkdownHTMLResultado
Abreviaturas
*[HTML]: Hyper Text Markup Language
La especificación HTML es mantenida
por la asociación W3C.
La especificación
<abbr title="Hyper Text Markup Language">HTML</abbr>
es mantenida por la asociación W3C.
La especificación HTML es mantenida por la asociación W3C.

Alternativas a GitHub Pages

Si prefieres usar un generador de sitios web estático diferente a Jekyll, también puedes generar un sitio web estático localmente usando React, Vue o Hugo y publicarlo en GitHub Pages:

  • Introducción a React: Para aprender a usar React y a generar una web estática con este framework y publicarla en GitHub pages, consulta el tutorial de introducción a React.
  • Introducción a Vue: Para aprender a usar Vue y a generar una web estática con este framework y publicarla en GitHub pages, consulta el tutorial de introducción a Vue.

En caso de que quieras publicar la documentación de algún proyecto, puedes usar Docusaurus o también MkDocs.

Más información

Para obtener más información acerca de GitHub Pages, puedes consultar los siguientes enlaces: