Acerca de las Páginas de GitHub y Jekyll

En este artículo

• Acerca de Jekyll
• Configurando Jekyll en tu sitio Páginas de GitHub
• Texto preliminar
• Temas
• Plugins
• Resaltado de la sintaxis
• Construyendo su sitio localmente

Acerca de Jekyll

Jekill es un generador de sitio estático con soporte incorporado para Páginas de GitHub y un proceso de construcción simplificado. Jekyll toma los archivos Markdown y HTML y crea un sitio web estático completo en función de la opción de diseño. Jekyll soporta Markdown y Liquid, un lenguaje de plantillas que carga contenido dinámico en tu sitio. Para obtener más información, consulta Jekyll.

Jekyll no está oficialmente admitido por Windows. Para obtener más información, consulta "Jekyll en Windows" en la documentación de Jekyll.

Recomandamos usar Jekyll con Páginas de GitHub. Si lo prefieres, puedes usar otros generadores de sitio estático o personalizar tu propio proceso de compilación localmente o en otro servidor. Para obtener más información, consulta "Acerca de Páginas de GitHub".

Configurando Jekyll en tu sitio Páginas de GitHub

Puedes configurar la mayoría de los parámetros de Jekyll, como los temas y los plugins del sitio, al editar tu archivo _config.yml. Para obtener más información, consulte "Configuración" en la documentación de Jekyll.

Algunos parámetros de configuración no pueden cambiarse para los sitios Páginas de GitHub sites.

lsi: false
safe: true
source: [your repo's top level directory]
incremental: false
highlighter: rouge
gist:
  noscript: false
kramdown:
  math_engine: mathjax
  syntax_highlighter: rouge

De manera predeterminada, Jekyll no compila archivos o carpetas que:

• están situados en una carpeta denominada /node_modules o /vendor
• comienza con _, ., o #
• termina con ~
• están excluidos por el parámetro exclude en tu archivo de configuración

Si deseas que Jekyll procese alguno de estos archivos, puedes usar el parámetro includes en tu archivo de configuración.

Texto preliminar

To set variables and metadata, such as a title and layout, for a page or post on your site, you can add YAML front matter to the top of any Markdown or HTML file. For more information, see "Front Matter" in the Jekyll documentation.

Puedes añadir site.github a una publicación o página para añadir cualquier metadato de referencias de repositorio a tu sitio. Para obtener más información, consulta "Usar site.github" en la documentación de metadatos de Jekyll.

Temas

You can add a Jekyll theme to your Páginas de GitHub site to customize the look and feel of your site. Para obtenerr más información, consulta "Temas" en la documentación de Jekyll.

You can add a theme to your site manually. For more information, see "Supported themes" on the Páginas de GitHub site and "Adding a theme to your Páginas de GitHub site using Jekyll."

Puedes sobrescribir cualquiera de los valores por defecto de tu tema editando los archivos del tema. Para obtener más información, consulta la documentación de tu tema y "Sobrescribir los valores predeterminados del tema" en la documentación de Jekyll.

Plugins

Puedes descargar o crear plugins Jekyll para ampliar la funcionalidad de Jekyll para tu sitio. Por ejemplo, el plugin jemoji te permite usar el emoji con formato GitHub en cualquier página de tu sitio del mismo modo que lo harías en GitHub. Para obtener más información, consulta "Plugins" en la documentación de Jekyll.

Páginas de GitHub usa plugins que están habilitados por defecto y no pueden estar inhabilitados:

• jekyll-coffeescript
• jekyll-default-layout
• jekyll-gist
• jekyll-github-metadata
• jekyll-optional-front-matter
• jekyll-paginate
• jekyll-readme-index
• jekyll-titles-from-headings
• jekyll-relative-links

Puedes habilitar plugins adicionales al agregar la gema del plugin en los ajustes de plugins en tu archivo _config.yml. Para obtener más información, consulta "Configuración" en la documentación de Jekyll. Para conocer la lista de los plugins soportados, consulta "Versiones de dependencia" en el sitio Páginas de GitHub.

Para obtener información de uso de un plugin específico, consulta la documentación del plugin.

Páginas de GitHub no puede compilar sitios mediante plugins no compatibles. Si deseas usar plugins no compatibles, genera tu sitio localmente y luego sube los archivos estáticos del sitio a GitHub Enterprise.

Resaltado de la sintaxis

Para facilitar la lectura de tu sitio, los fragmentos de código se resaltan en los sitios de Páginas de GitHub de la misma manera que se resaltan en GitHub Enterprise. Para más información sobre como enfatizar sintaxis en GitHub Enterprise, vea "Creando y resaltando bloques de código."

Por defecto, los bloques de código en su sitio serán resaltados por Jekyll. Jekyll utiliza el resaltador de Rouge, compatible con Pygments. Si especificas Pygments en tu archivo _config.yml, el Rouge se utilizará en su lugar. Jekyll no puede usar ningún otro resaltador de sintaxis, y obtendrás una advertencia de compilación de página si especificas otro en tu archivo _config.yml. Para más información, vea "Acerca de los errores de construcción de sitios Jekyll Páginas de GitHub ."

Si quieres usar otro resaltador, como highlight.js, debes desactivar el resaltador de sintaxis de Jekyll actualizando el archivo de tu proyecto _config.yml.

kramdown:
  syntax_highlighter_opts:
    disable : true

Si tu tema no incluye CSS para resaltar la sintaxis, puedes generar la sintaxis de GitHub resaltando CSS y añadirlo a tu archivo style.css de proyecto.

$ rougify style github > style.css

Construyendo su sitio localmente

Changes to your site are published automatically when the changes are merged into your site's publishing source. If you want to preview your changes first, you can make the changes locally instead of on GitHub Enterprise. Then, test your site locally. Para obtener más información, consulta "Verificar tu sitio de Páginas de GitHub localmente con Jekyll".