Creating a GitHub Pages site with Jekyll

Prerequisites

Before you can use Jekyll to create a GitHub Pages site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and "Set up Git."

Se recomienda usar 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. Instale Ruby. Para más información, vea "Instalación de Ruby" en la documentación de Ruby.
2. Instale Bundler. Para más información, vea "Bundler".

Creating a repository for your site

Puedes crear un repositorio o elegir un repositorio existente para el sitio.

Si quieres crear un sitio de GitHub Pages para un repositorio donde no todos los archivos del repositorio están relacionados con el sitio, podrás configurar una fuente de publicación para el sitio. Por ejemplo, puedes tener una rama dedicada y una carpeta para contener los archivos de origen del sitio , o bien usar un flujo de trabajo de GitHub Actions personalizado para compilar e implementar los archivos de origen del sitio.

Si la cuenta a la que pertenece el repositorio utiliza GitHub Free o GitHub Free para organizaciones, el repositorio deberá ser público.

Si quiere crear un sitio en un repositorio existente, vaya a la sección "Crear tu sitio".

1. En la esquina superior derecha de cualquier página, utiliza el menú desplegable y selecciona New repository (Nuevo repositorio).

2. Utilice el menú desplegable Owner (Propietario) y seleccione la cuenta de la que quiera ser propietaria del repositorio.

   Note: If you're a managed user account, you can only publish GitHub Pages sites from repositories owned by organizations. For more information, see "About GitHub Pages."

3. Escribe un nombre para tu repositorio y una descripción opcional. Si va a crear un sitio de usuario u organización, el repositorio debe tener el nombre <user>.github.io o <organization>.github.io. Si tu nombre de organización o usuario contiene mayúsculas, debes hacerlas minúsculas. Para más información, vea "Acerca de GitHub Pages".

4. Elige la visibilidad del repositorio. Para más información, vea "Acerca de los repositorios".

Creating your site

Antes de que puedas crear tu sitio, debes tener un repositorio para el mismo en GitHub Enterprise Cloud. Si no va a crear el sitio en un repositorio existente, vea "Creación de un repositorio para el sitio".

1. Abra TerminalTerminalGit Bash.

2. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing PARENT-FOLDER with the folder you want to contain the folder for your repository.

   $ cd PARENT-FOLDER

3. If you haven't already, initialize a local Git repository, replacing REPOSITORY-NAME with the name of your repository.

   $ 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. Change directories to the repository.

   $ cd REPOSITORY-NAME
   # Changes the working directory

5. Decide qué fuente de publicación quieres utilizar. Para más información, consulta "Configuración de una fuente de publicación para el sitio de GitHub Pages."

6. Navega a la fuente de publicación para tu sitio. Para más información, consulta "Configuración de una fuente de publicación para el sitio de GitHub Pages." For example, if you chose to publish your site from the docs folder on the default branch, create and change directories to the docs folder.

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

   If you chose to publish your site from the gh-pages branch, create and checkout the gh-pages branch.

   $ git checkout --orphan gh-pages
   # Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch
   $ git rm -rf .
   # Removes the contents from your default branch from the working directory

7. To create a new Jekyll site, use the jekyll new command:

   $ jekyll new --skip-bundle .
   # Creates a Jekyll site in the current directory

8. Open the Gemfile that Jekyll created.

9. Add "#" to the beginning of the line that starts with gem "jekyll" to comment out this line.

10. Add the github-pages gem by editing the line starting with # gem "github-pages". Change this line to:

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

    Replace GITHUB-PAGES-VERSION with the latest supported version of the github-pages gem. You can find this version here: "Dependency versions."

    The correct version Jekyll will be installed as a dependency of the github-pages gem.

11. Save and close the Gemfile.

12. From the command line, run bundle install.

13. Optionally, make any necessary edits to the _config.yml file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "Splitting a subfolder out into a new repository."

    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. Optionally, test your site locally. For more information, see "Testing your GitHub Pages site locally with Jekyll."

15. Add and commit your work.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'

16. Add your repository on GitHub.com as a remote, replacing USER with the account that owns the repository and REPOSITORY with the name of the repository.

    $ git remote add origin https://github.com/USER/REPOSITORY.git
    

17. Push the repository to GitHub Enterprise Cloud, replacing BRANCH with the name of the branch you're working on.

    $ git push -u origin BRANCH

18. Configura tu fuente de publicción. Para más información, vea "Configuración de un origen de publicación para el sitio de GitHub Pages".

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

20. Debajo del nombre del repositorio, haz clic en Configuración.

21. In the "Code and automation" section of the sidebar, click Pages.

22. Opcionalmente, si vas a publicar un sitio de proyecto desde un repositorio privado o interno, elige la visibilidad del sitio. En "GitHub Pages", seleccione el menú desplegable GitHub Pages visibility y luego haga clic en una visibilidad. Para obtener más información, vea "Cambiar la visibilidad del sitio de GitHub Pages".

    Nota: Para publicar un sitio de GitHub Pages de forma privada, la organización debe usar GitHub Enterprise Cloud. Para más información sobre cómo probar GitHub Enterprise Cloud de forma gratuita, vea "Configuración de una versión de prueba de GitHub Enterprise Cloud".

23. Para ver tu sitio publicado, debajo de "GitHub Pages", da clic en la URL del mismo.

    Nota: Es posible que la publicación de los cambios en el sitio tome hasta 10 minutos después de que envíes los cambios a GitHub Enterprise Cloud. Si no ves los cambios del sitio GitHub Pages reflejados en el explorador después de una hora, consulta Acerca de los errores de compilación de Jekyll para sitios de GitHub Pages.

24. Su GitHub Pages sitio se construye y se implementa con un GitHub Actions flujo de trabajo. Para más información, vea "Visualización del historial de ejecución de flujos de trabajo".

    Nota GitHub Actions es gratuito para los repositorios públicos. Los cargos de uso se aplican a repositorios privados e internos que van más allá de la asignación mensual de minutos gratuitos. Para más información, vea "Límites de uso, facturación y administración".

Next steps

To add a new page or post to your site, see "Adding content to your GitHub Pages site using Jekyll."

Puedes agregar un tema de Jekyll a tu sitio de GitHub Pages para personalizar la apariencia de tu sitio. For more information, see "Adding a theme to your GitHub Pages site using Jekyll."