Crear un sitio de Páginas de GitHub con Jekyll

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

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. Si tu sitio se asocia con un proyecto existente, puedes agregar el código fuente de tu sitio en una rama de tipo gh-pages o en una carpeta de tipo docs en la rama master en el repositorio de ese proyecto. Por ejemplo, si estás creando un sitio para publicar documentación para un proyecto que ya está en GitHub Enterprise, 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.
   
2. Utiliza el menú desplegable de Propietario y selecciona la cuenta que quieres sea propietaria del repositorio.
   
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. Para obtener más información, consulta "Acerca de Páginas de GitHub".
   
4. Elige un tipo de visibilidad para el repositorio. Para obtener más información, consulta la sección "Acerca de la visibilidad del repositorio".
   

Crear tu sitio

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

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. So estás creando un sitio de proyecto, decide qué fuente de publicación quieres utilizar. Si estás creando un sitio de usuario o de organización, debes almacenar el código fuente de tu sitio en la rama master. 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 master (principal), 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 Jekyll nuevo, usa el comando jekyll new y reemplaza VERSION por la versión de dependencias actual para Jekyll. Para obtener más información, consulta "Versiones de dependencias" en el sitio de Páginas de GitHub.

   • Si instalaste Bundler:

     $ bundle exec jekyll VERSION new .
     # Creates a Jekyll site in the current directory

   • Si no tienes instalado Bundler:

     $ jekyll VERSION new .
     # Creates a Jekyll site in the current directory

8. Abre el Gemfile que se creó y sigue las instrucciones de los comentarios del Gemfile para usar las Páginas de GitHub.

   

9. Actualiza la línea gem "github-pages" para que luzca así, reemplazando VERSION por la versión de dependencias actual para github-pages. Para obtener más información, consulta "Versiones de dependencias" en el sitio de Páginas de GitHub.

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

10. Guarda y cierra el Gemfile.

11. De forma opcional, prueba tu sitio localmente. Para obtener más información, consulta "Probar tu sitio de Páginas de GitHub localmente con Jekyll".

12. Agrega tu repositorio GitHub Enterprise como remoto, reemplazando HOSTNAME con el nombre del host de tu aparato, USER_por la cuenta que le pertenece al repositorio, y _REPOSITORY por el nombre del repositorio.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    

13. Sube el repositorio a GitHub Enterprise, reemplazando BRANCH por el nombre de la rama en la que estás trabajando.

    $ git push -u origin BRANCH

14. Si estás utilizando una fuente no predeterminada de publicación para un sitio de proyecto, configura tu fuente de publicación. Para obtener más información, consulta "Configurar una fuente de publicación para tu sitio Páginas de GitHub".

15. En GitHub Enterprise, navega al repositorio de tu sitio.

16. Debajo de tu nombre de repositorio, da clic en Configuración.

    

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

    

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

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