Configurar un procesador Markdown para tu sitio de páginas de GitHub usando Jekyll

Puedes elegir un procesador Markdown para determinar la manera en que Markdown se representa en tu sitio de GitHub Pages.

¿Quién puede utilizar esta característica?

GitHub Pages se encuentra disponible en los repositorios públicos con GitHub Free y con GitHub Free para las organizaciones, y en los repositorios públicos y privados con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y GitHub Enterprise Server. Para más información, consulta Planes de GitHub.

GitHub Pages ahora usan GitHub Actions para ejecutar la compilación de Jekyll. Al usar una rama como origen de la compilación, se deben habilitar GitHub Actions en el repositorio si deseas usar el flujo de trabajo integrado de Jekyll. Como alternativa, si no están disponibles o se han deshabilitado GitHub Actions, agregar un archivo .nojekyll a la raíz de la rama de origen omitirá el proceso de compilación de Jekyll e implementará el contenido directamente. Para más información sobre la habilitación de GitHub Actions, consulta Administrar los ajustes de las GitHub Actions de un repositorio.

Las personas con permisos de escritura para un repositorio pueden configurar el procesador Markdown para un sitio de GitHub Pages.

GitHub Pages admite dos procesadores de Markdown: kramdown y el propio procesador de Markdown de GitHub, que se usa para representar GitHub Flavored Markdown (GFM) desde GitHub. Para más información, consulta Acerca de escritura y formato en GitHub.

Puedes usar Markdown de tipo GitHub con cualquiera de los procesadores.

  1. En GitHub, navega al repositorio de tu sitio.
  2. En el repositorio, ve al archivo config.yml.
  3. En la esquina superior derecha de la vista de archivos, haz clic en para abrir el editor de archivos.

Captura de pantalla de un archivo. En el encabezado, un botón (etiquetado con un icono de lápiz) está resaltado en naranja oscuro.

Note

En lugar de editar y confirmar el archivo con el editor de archivos predeterminado, puedes optar por usar el editor de código github.dev; para ello, selecciona el menú desplegable y haz clic en github.dev. También puedes clonar el repositorio y editar el archivo localmente a través de GitHub Desktop haciendo clic en GitHub Desktop .

Captura de pantalla de un archivo. En el encabezado, un icono de triángulo hacia abajo está resaltado en naranja oscuro.

  1. Busque la línea que comienza por markdown: y cambie el valor a kramdown o GFM. La línea completa debe ser markdown: kramdown o markdown: GFM.

  2. Haz clic en Confirmar cambios... .

  3. En el campo de "Mensaje de confirmación", escriba un mensaje de confirmación corto y significativo que describa la modificación que hizo en el archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para más información, consulta Crear una confirmación con distintos autores.

  4. Si tiene más de una dirección de correo electrónico asociada a la cuenta en , haga clic en el menú desplegable de la dirección de correo electrónico y seleccione la que se usará como dirección de correo electrónico del creador de Git. Únicamente las direcciones de correo electrónico verificadas aparecen en el menú desplegable. Si ha habilitado la privacidad de la dirección de correo electrónico, una dirección de correo electrónico no responder del creador de la confirmación será la predeterminada. Para más información sobre el formato exacto que puede tomar la dirección de correo electrónico sin respuesta, consulta Configurar tu dirección de correo electrónico de confirmación.

    Captura de pantalla de una solicitud de cambios de GitHub en la que se muestra un menú desplegable con opciones para elegir la dirección de correo electrónico del creador de la confirmación. octocat@github.com aparece como que se seleccionó.

  5. Debajo de los campos para el mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una nueva rama. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para más información, consulta Crear una solicitud de incorporación de cambios.

    Captura de pantalla de una solicitud de cambios de GitHub en la que se muestra un botón de radio para confirmar directamente en la rama principal o para crear una rama. Aparece seleccionada la opción de rama nueva.

  6. Haz clic en Confirmar cambios o Proponer cambios.

Información adicional