Crear un sitio de Páginas de GitHub con Jekyll

En este artículo

• Prerrequisitos
• Crear un repositorio para tu sitio
• Crear tu sitio
• Pasos siguientes

Las personas con permisos de administración para un repositorio pueden 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. To install Bundler:

1. Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
2. Instala Bundler. For more information, see "Bundler."

Crear un repositorio para tu sitio

If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code for your site to a gh-pages branch or a docs folder on the master branch in that project's repository. For example, if you're creating a site to publish documentation for a project that's already on GitHub Enterprise, you may want to store the source code for the site in the same repository as the project.

If you want to create a site in an existing repository, skip to the "Creating your site" section.

1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

   

2. Use the Owner drop-down menu, and select the account you want to own the repository.

   

3. Escribe un nombre para tu repositorio y una descripción opcional. If you're creating a user or organization site, your repository must be named <user>.github.io or <organization>.github.io. Para obtener más información, consulta "Acerca de Páginas de GitHub".

   

4. Choose to make the repository either public or private. Public repositories are visible to everyone using tu instancia de servidor de GitHub Enterprise, while private repositories are only accessible to you, and people you share them with. Para obtener más información, consulta "Configurar la visibilidad de un repositorio".

   

Crear tu sitio

Before you can create your site, you must have a repository for your site on GitHub Enterprise. If you're not creating your site in an existing repository, see "Creating a repository for your site."

1. Open 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. If you're creating a project site, decide which publishing source you want to use. If you're creating a user or organization site, you must store your site's source code on the master branch. For more information, see "About Páginas de GitHub."

6. Navigate to the publishing source for your site. 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. If you're using a non-default publishing source for a project site, configure your publishing source. Para obtener más información, consulta "Configurar una fuente de publicación para tu sitio Páginas de GitHub".

15. On GitHub Enterprise, navigate to your site's repository.

16. Under your repository name, click Settings.

    

17. To see your published site, under "Páginas de GitHub", click your site's URL.

    

    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. If your don't see your changes reflected in your browser after an hour, see "About Jekyll build errors for Páginas de GitHub sites."

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

You can add a Jekyll theme to your Páginas de GitHub site to customize the look and feel of your site. Para obtener más información, consulta "Agregar un tema a tu sitio de Páginas de GitHub con Jekyll".