Esta versión de GitHub Enterprise se discontinuará el 2021-09-23. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener un mejor desempeño, más seguridad y nuevas características, actualiza a la última versión de GitHub Enterprise. Para obtener ayuda con la actualización, contacta al soporte de GitHub Enterprise.

About GitHub Pages and Jekyll

Jekyll is a static site generator with built-in support for Páginas de GitHub.

Páginas de GitHub se encuentra disponible en repositorios públicos con GitHub Free y GitHub Free para organizaciones, y en repositorios privados y públicos con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y Servidor de GitHub Enterprise.

About Jekyll

Jekyll is a static site generator with built-in support for Páginas de GitHub and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see Jekyll.

Jekyll is not officially supported for Windows. For more information, see "Jekyll on Windows" in the Jekyll documentation.

We recommend using Jekyll with Páginas de GitHub. If you prefer, you can use other static site generators or customize your own build process locally or on another server. For more information, see "About Páginas de GitHub."

Configuring Jekyll in your Páginas de GitHub site

You can configure most Jekyll settings, such as your site's theme and plugins, by editing your _config.yml file. For more information, see "Configuration" in the Jekyll documentation.

Some configuration settings cannot be changed for 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

By default, Jekyll doesn't build files or folders that:

  • are located in a folder called /node_modules or /vendor
  • start with _, ., or #
  • end with ~
  • are excluded by the exclude setting in your configuration file

If you want Jekyll to process any of these files, you can use the include setting in your configuration file.

Front matter

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 la sección "Front Matter" en la documentación de Jekyll.

You can add site.github to a post or page to add any repository references metadata to your site. For more information, see "Using site.github" in the Jekyll Metadata documentation.

Themes

Puedes agregar un tema de Jekyll a tu sitio de Páginas de GitHub para personalizar la apariencia de tu sitio. For more information, see "Themes" in the Jekyll documentation.

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."

You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "Overriding your theme's defaults" in the Jekyll documentation.

Plugins

You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the jemoji plugin lets you use GitHub-flavored emoji in any page on your site the same way you would on GitHub. For more information, see "Plugins" in the Jekyll documentation.

Páginas de GitHub uses plugins that are enabled by default and cannot be disabled:

You can enable additional plugins by adding the plugin's gem to the plugins setting in your _config.yml file. For more information, see "Configuration" in the Jekyll documentation.

For a list of supported plugins, see "Dependency versions" on the Páginas de GitHub site. For usage information for a specific plugin, see the plugin's documentation.

Tip: You can make sure you're using the latest version of all plugins by keeping the Páginas de GitHub gem updated. For more information, see "Testing your GitHub Pages site locally with Jekyll" and "Dependency versions" on the Páginas de GitHub site.

Páginas de GitHub cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to GitHub Enterprise.

Syntax highlighting

To make your site easier to read, code snippets are highlighted on Páginas de GitHub sites the same way they're highlighted on GitHub Enterprise. For more information about syntax highlighting on GitHub Enterprise, see "Creating and highlighting code blocks."

By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the Rouge highlighter, which is compatible with Pygments. If you specify Pygments in your _config.yml file, Rouge will be used instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your _config.yml file. For more information, see "About Jekyll build errors for Páginas de GitHub sites."

If you want to use another highlighter, such as highlight.js, you must disable Jekyll's syntax highlighting by updating your project's _config.yml file.

kramdown:
  syntax_highlighter_opts:
    disable : true

If your theme doesn't include CSS for syntax highlighting, you can generate GitHub's syntax highlighting CSS and add it to your project's style.css file.

$ rougify style github > style.css

Building your site locally

Los cambios en tu sitio se publican automáticamente cuando se fusionan con la fuente de publicación de tu sitio. Si quieres pre-visualizar tus cambios primero, puedes hacer los cambios localmente en vez de en GitHub Enterprise. Después, prueba tu sitio localmente. Para obtener más información, consulta "Verificar tu sitio de Páginas de GitHub localmente con Jekyll".

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.