Acerca de las Páginas de GitHub y Jekyll

Acerca de Jekyll

Jekill es un generador de sitio estático con soporte incorporado para GitHub Pages 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 más información, vea Jekyll.

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

Recomandamos usar Jekyll con GitHub Pages. 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 más información, vea "Acerca de GitHub Pages".

Configurando Jekyll en tu sitio GitHub Pages

Puede configurar la mayoría de los valores de Jekyll, como los temas y los plugins del sitio, si edita el archivo _config.yml. Para más información, vea "Configuración" en la documentación de Jekyll.

Algunos parámetros de configuración no pueden cambiarse para los sitios GitHub Pages 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:

se encuentran en una carpeta denominada /node_modules o /vendor
comienzan por _, . o #
terminan con ~
se excluyen mediante el valor exclude del archivo de configuración

Si quiere que Jekyll procese cualquiera de estos archivos, puede usar el valor include del archivo de configuración.

Texto preliminar

Para configurar variables y metadatos, tales como el título y diseño, de una página o publicación en tu sitio, puedes agregar YAML front matter a la parte superior de cualquier archivo Markdown o HTML. Para obtener más información, consulta "Texto preliminar" en la documentación de Jekyll.

Puede agregar site.github a una publicación o página para agregar los metadatos de referencias del repositorio al sitio. Para más información, vea "Uso de site.github" en la documentación de metadatos de Jekyll.

Temas

Puedes agregar un tema de Jekyll a tu sitio de GitHub Pages para personalizar la apariencia de tu sitio. Para más información, vea "Temas" en la documentación de Jekyll.

Puede agregar manualmente un tema al sitio. Para más información, vea "Temas admitidos" en el sitio de GitHub Pages y "Adición de un tema al sitio de GitHub Pages mediante Jekyll".

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

Complementos

Puedes descargar o crear plugins Jekyll para ampliar la funcionalidad de Jekyll para tu sitio. Por ejemplo, el complemento jemoji le permite usar emoji de estilo GitHub en cualquier página del sitio de la misma manera que lo haría en GitHub. Para más información, vea "Complementos" en la documentación de Jekyll.

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

Puede habilitar complementos adicionales si agrega la gema del complemento al valor plugins en el archivo _config.yml. Para más información, vea "Configuración" en la documentación de Jekyll.

Para obtener una lista de los complementos admitidos, vea "Versiones de dependencia" en el sitio de GitHub Pages. Para obtener información de uso de un plugin específico, consulta la documentación del plugin.

Sugerencia: Puede asegurarse de que usa la versión más reciente de todos los complementos si mantiene actualizada la gema de GitHub Pages. Para más información, vea "Prueba del sitio de GitHub Pages localmente con Jekyll" y "Versiones de dependencia" en el sitio de GitHub Pages.

GitHub Pages 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 Server.

Resaltado de sintaxis

Para facilitar la lectura de tu sitio, los fragmentos de código se resaltan en los sitios de GitHub Pages de la misma manera que se resaltan en GitHub Enterprise Server. Para más información sobre el resaltado de sintaxis en GitHub Enterprise Server, vea "Creación y resaltado de bloques de código".

Por defecto, los bloques de código en su sitio serán resaltados por Jekyll. Jekyll usa el resaltado Rouge, que es compatible con Pygments. Pygments se obsoletizó y no es compatible con Jekyll 4. Si especifica Pygments en el archivo _config.yml, Rouge se usará como reserva en su lugar. Jekyll no puede usar ningún otro resaltador de sintaxis, y obtendrá una advertencia de compilación de página si especifica otro distinto en el archivo _config.yml. Para más información, vea "Acerca de los errores de compilación de Jekyll para sitios de GitHub Pages".

Si quiere usar otro resaltador, como highlight.js, debe deshabilitar el resaltado de sintaxis de Jekyll mediante la actualización del archivo _config.yml del proyecto.

kramdown:
  syntax_highlighter_opts:
    disable : true

Si en el tema no se incluye CSS para el resaltado de sintaxis, puede generar CSS de resaltado de sintaxis de GitHub y agregarlo al archivo style.css del proyecto.

$ rougify style github > style.css

Construyendo tu sitio localmente

Changes en tu sitio se publican automáticamente cuando se fusionan con la fuente de publicación de tu sitio. Si quieres previsualizar tus cambios primero, puedes hacer los cambios localmente en vez de en GitHub Enterprise Server. Después, prueba tu sitio localmente. Para obtener más información, vea "Probar tu sitio de GitHub Pages localmente con Jekyll".