Crear un sitio de Páginas de GitHub con Jekyll

Puedes usar Jekyll para crear un sitio de Páginas de GitHub en un repositorio nuevo o existente.

People with admin permissions for a repository can create a Páginas de GitHub site with Jekyll.

Páginas de GitHub 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, Nube de GitHub Enterprise, y GitHub Enterprise Server.

Nota: Los propietarios de la organización pueden restringir la publicación de sitios de Páginas de GitHub desde los repositorios que le pertenezcan a dicha organización. Para obtener más información, consulta la sección "Administrar la publicación de sitios de Páginas de GitHub".

Prerrequisitos

Antes de que puedas usar Jekyll para crear un sitio de Páginas de GitHub, debes instalar Jekyll y Git. Para obtener más información, consulta Instalación en la documentación de Jekyll y "Configurar Git".

Recomendamos utilizando Bundler para instalar y ejecutar Jekyll. Bundler administra las dependencias de gema de Ruby, reduce los errores de construcción de Jekyll y evita los errores relacionados con el entorno. Para instalar Bundler:

  1. Instala Ruby. Para obtener más información, consulta "Instalar Ruby" en la documentación de Ruby.
  2. Instala Bundler. Para obtener más información, visita "Bundler".

Sugerencia: si ves un error de Ruby cuando tratas de instalar Jekyll utilizando Bundler, es posible que necesites utilizar un administrador de paquete, como RVM o Homebrew, para administrar tu instalación de Ruby. Para obtener más información, consulta la sección "Solución de problemas" en la documentación de Jekyll.

Crear un repositorio para tu sitio

Si tu sitio es un proyecto independiente, puedes crear un repositorio nuevo para almacenar el código fuente del mismo. If your site is associated with an existing project, you can add the source code to that project's repository, in a /docs folder on the default branch or on a different branch. Por ejemplo, si estás creando un sitio para publicar documentación para un proyecto que ya está en GitHub Enterprise Server, podrías querer almacenar el código fuente para este sitio en el mismo repositorio donde se encuentra el proyecto.

Si quieres crear un sitio en un repositorio existente, salta hasta la sección "Crear tu sitio".

  1. En la esquina superior derecha de cualquier página, utiliza el menú desplegable y selecciona Repositorio Nuevo. Menú desplegable con opción para crear un repositorio nuevo
  2. Utiliza el menú desplegable de Propietario y selecciona la cuenta que quieres sea propietaria del repositorio. Menú desplegable Propietario
  3. Escribe un nombre para tu repositorio y una descripción opcional. Si estás creando un sitio de usuario u organización, tu repositorio se debe nombrar <user>.github.io o <organization>.github.io. Si tu nombre de organización o usuario contiene mayúsculas, debes hacerlas minúsculas. Para obtener más información, consulta la sección "Acerca de Páginas de GitHub". Crear un campo de repositorio
  4. Elige la visibilidad del repositorio. Para obtener más información, consulta la sección "Acerca de los repositorios". Botones radiales para seleccionar la visibilidad del repositorio

Crear tu sitio

Antes de que puedas crear tu sitio, debes tener un repositorio para el mismo en GitHub Enterprise Server. Si no estás creando tu sitio en un repositorio existente, consulta la sección "Crear un repositorio para tu sitio".

Warning: If your site administrator has enabled Public Pages, Páginas de GitHub sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "Configuring Páginas de GitHub for your enterprise" and "About repositories."

  1. Abre la TerminalTerminalGit Bash.

  2. Si aún no tienes una copia local de tu repositorio, desplázate hasta la ubicación en la que quieras almacenar los archivos fuente de tu sitio y reemplaza PARENT-FOLDER por la carpeta que quieras que contenga la carpeta para su repositorio.

    $ cd PARENT-FOLDER
  3. Si aún no lo has hecho, inicia un repositorio de Git local reemplazando REPOSITORY-NAME por el nombre de tu repositorio.

    $ git init REPOSITORY-NAME
    > Initialized empty Git repository in /Users/octocat/my-site/.git/
    # Creates a new folder on your computer, initialized as a Git repository
  4. Cambio los directorios para el repositorio.

    $ cd REPOSITORY-NAME
    # Changes the working directory
  5. Decide which publishing source you want to use. Para obtener más información, consulta la sección "Acerca dePáginas de GitHub".

  6. Navega a la fuente de publicación para tu sitio. Para obtener más información acerca de las fuentes de publicación, consulta "Acerca de las Páginas de GitHub". Por ejemplo, si decides publicar tu sitio desde la carpeta docs de la rama predeterminada, crea y cambia los directorios para la carpeta docs.

    $ mkdir docs
    # Creates a new folder called docs
    $ cd docs

    Si decides publicar tu sitio desde la rama gh-pages, crea y controla la rama gh-pages.

    $ git checkout --orphan gh-pages
    # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch
  7. Para crear un sitio nuevo de Jekyll, utiliza el comando jekyll new:

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
  8. Abre el Gemfile que creó Jekyll.

  9. Agrega "#" en el inicio de la línea que comienza con gem "jekyll" para comentar esta línea.

  10. Agrega la gema github-pages editando la línea que comienza con # gem "github-pages". Cambia la línea a:

    gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins

    Reemplaza GITHUB-PAGES-VERSION con la última versión compatible de la gema github-pages. Puedes encontrar esta versión aquí: "Versiones de la dependencia".

    La versión correcta de Jekyll se instalará como una dependencia de la gema github-pages.

  11. Guarda y cierra el Gemfile.

  12. Desde la línea de comandos, ejecuta bundle install.

  13. Opcionalmente, haz cualquier edición necesaria en el archivo _config.yml. Esto se requiere para las rutas relativas cuando el repositorio se hospeda en un subdirectorio. Para obtener más información, consulta la sección "Dividir una subcarpeta en un repositorio nuevo".

    domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
    url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
    baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder
    
  14. De forma opcional, prueba tu sitio localmente. Para obtener más información, consulta "Verificar tu sitio de Páginas de GitHub localmente con Jekyll".

  15. Agrega y confirma tu trabajo.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  16. Add your repository on your GitHub Enterprise Server instance as a remote, replacing HOSTNAME with your enterprise's hostname, USER with the account that owns the repository, and REPOSITORY with the name of the repository.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    
  17. Sube el repositorio a GitHub Enterprise Server, reemplazando BRANCH por el nombre de la rama en la que estás trabajando.

    $ git push -u origin BRANCH
  18. Configura tu fuente de publicción. Para obtener más información, consulta "Configurar una fuente de publicación para tu sitio Páginas de GitHub".

  19. En GitHub Enterprise Server, navega al repositorio de tu sitio.

  20. Debajo de tu nombre de repositorio, da clic en Configuración. Botón de configuración del repositorio

  21. En la barra lateral izquierda, da clic en Páginas. Pestaña de página en la barra lateral izquierda

  22. Para ver tu sitio publicado, debajo de "Páginas de GitHub", da clic en la URL del mismo. URL de tu sitio publicado

    Nota: Es posible que tome hasta 20 minutos la publicación de los cambios en tu sitio luego de que subes los cambios a GitHub Enterprise Server. Si no ves los cambios reflejados en tu buscador después de una hora, consulta la sección "Acerca de los errores de compilación de Jekyll para sitios de Páginas de GitHub".

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

Pasos siguientes

Para agregar una página o publicación nueva a tu sitio, consulta "Agregar contenido a tu sitio de Páginas de GitHub con Jekyll".

Puedes agregar un tema de Jekyll a tu sitio de Páginas de GitHub para personalizar la apariencia de tu sitio. Para obtener más información, consulta "Agregar un tema a tu sitio de Páginas de GitHub con Jekyll".

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.