Crear un sitio de Páginas de GitHub

Puede crear un sitio de GitHub Pages en un repositorio nuevo o existente.

¿Quién puede utilizar esta característica?

GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub’s plans."

GitHub Pages now uses GitHub Actions to execute the Jekyll build. When using a branch as the source of your build, GitHub Actions must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if GitHub Actions is unavailable or disabled, adding a .nojekyll file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling GitHub Actions, see "Managing GitHub Actions settings for a repository."

En este artículo

Nota: Los propietarios de la organización pueden restringir la publicación de sitios de GitHub Pages desde los repositorios que pertenezcan a dicha organización. Para obtener más información, vea «Administrar la publicación de sitios de GitHub Pages de tu organización».

Crear un repositorio para tu sitio

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, selecciona y luego haz clic en Nuevo repositorio.

    Captura de pantalla del menú desplegable GitHub que muestra las opciones para crear nuevos elementos. El elemento de menú "New repository" está resaltado en naranja oscuro.

  2. Usa el menú desplegable Propietario para seleccionar la cuenta que quieres que sea propietaria del repositorio.

    Captura de pantalla del menú del propietario de un repositorio de GitHub nuevo. El menú muestra dos opciones, octocat y github.

  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 obtener más información, vea «Acerca de GitHub Pages».

    Captura de pantalla de la configuración de GitHub Pages en un repositorio. El campo del nombre del repositorio contiene el texto "octocat.github.io" y aparece en naranja oscuro.

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

  5. Seleccione Initialize this repository with a README (Inicializar este repositorio con un archivo Léame).

  6. Haga clic en Create repository (Crear repositorio).

Crear tu sitio

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

Advertencia: Los sitios de GitHub Pages están disponibles públicamente en Internet, incluso si el repositorio del sitio es privado (si su plan u organización lo permite). Si tienes datos confidenciales en el repositorio del sitio, tal vez te interese eliminarlos antes de publicarlo. Para obtener más información, vea «Acerca de los repositorios».

  1. En GitHub, navega al repositorio de tu sitio.

  2. Decide qué fuente de publicación quieres utilizar. Para obtener más información, vea «Configurar una fuente de publicación para tu sitio de Páginas de GitHub».

  3. Crea el archivo de entrada para el sitio. GitHub Pages buscará un archivo index.html, index.md o README.md como archivo de entrada para el sitio.

    Si el origen de publicación es una rama y una carpeta, el archivo de entrada debe estar en el nivel superior de la carpeta de origen de la rama de origen. Por ejemplo, si la fuente de publicación es la carpeta /docs de la rama main, el archivo de entrada debe estar en la carpeta /docs de una rama denominada main.

    Si la fuente de publicación es un flujo de trabajo de GitHub Actions, el artefacto que implementes debe incluir el archivo de entrada en el nivel superior del artefacto. En lugar de agregar el archivo de entrada al repositorio, puedes decidir que el flujo de trabajo de GitHub Actions genere el archivo de entrada cuando se ejecute el flujo de trabajo.

  4. Configura tu fuente de publicción. Para obtener más información, vea «Configurar una fuente de publicación para tu sitio de Páginas de GitHub».

  5. En el nombre del repositorio, haz clic en Configuración. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  6. En la sección "Código y automatización" de la barra lateral, haz clic en Páginas.

  7. Para ver el sitio publicado, en "GitHub Pages", haz clic en Visitar sitio.

    Captura de pantalla de un mensaje de confirmación para GitHub Pages que muestra la dirección URL del sitio. A la derecha de la dirección URL, aparece un botón con la etiqueta "Visitar sitio" en color naranja oscuro.

    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. Si no ves los cambios del sitio de GitHub Pages reflejados en el explorador después de una hora, consulta "Acerca de los errores de compilación para sitios de Páginas de GitHub".

  8. Su GitHub Pages sitio se construye y se implementa con un GitHub Actions flujo de trabajo. Para más información, consulta "Visualizar el historial de ejecución del flujo 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, consulta "Límites de uso, facturación y administración".

Notas:

  • Si publicas desde una rama y el sitio no se ha publicado automáticamente, asegúrate de que alguien con permisos de administrador y una dirección de correo electrónico verificada haya insertado en la fuente de publicación.

  • Las confirmaciones insertadas por un flujo de trabajo de GitHub Actions que usa GITHUB_TOKEN no desencadenan una compilación de GitHub Pages.

Pasos siguientes

Puedes agregar más páginas a tu sitio creando más archivos nuevos. Cada archivo estará disponible en tu sitio en la misma estructura de directorios que tu fuente de publicación. Por ejemplo, si el origen de publicación del sitio del proyecto es la rama gh-pages y crea un nuevo archivo denominado /about/contact-us.md en la rama gh-pages, el archivo estará disponible en https://<user>.github.io/<repository>/about/contact-us.html.

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

Para personalizar aún más tu sitio, puedes usar Jekyll, un generador de sitio estático con soporte integrado para GitHub Pages. Para más información, consulta "Acerca de las Páginas de GitHub y Jekyll".

Información adicional