About GitHub Pages

You can use Páginas de GitHub to host a website about yourself, your organization, or your project directly from a GitHub Enterprise repository.

Páginas de GitHub se encuentra disponible en repositorios públicos con GitHub Free y GitHub Free para organizaciones, y en repositorios privados y públicos con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y Servidor de GitHub Enterprise.

About Páginas de GitHub

Páginas de GitHub is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub Enterprise, optionally runs the files through a build process, and publishes a website. You can see examples of Páginas de GitHub sites in the Páginas de GitHub examples collection.

To get started, see "Creating a Páginas de GitHub site."

Organization owners can disable the publication of Páginas de GitHub sites from the organization's repositories. For more information, see "Managing the publication of Páginas de GitHub sites for your organization."

Types of Páginas de GitHub sites

There are three types of Páginas de GitHub sites: project, user, and organization. Project sites are connected to a specific project hosted on GitHub Enterprise, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific GitHub Enterprise account.

To publish a user site, you must create a repository owned by your user account that's named <username>.<hostname>. To publish an organization site, you must create a repository owned by an organization that's named <organization>.<hostname>.

The source files for a project site are stored in the same repository as their project.

You can only create one user or organization site for each account on GitHub Enterprise. Project sites, whether owned by an organization or a user account, are unlimited.

The URL where your site is available depends on whether subdomain isolation is enabled for tu instancia de servidor de GitHub Enterprise.

Type of siteSubdomain isolation enabledSubdomain isolation disabled
Project site owned by user accounthttp(s)://pages.<hostname>/<username>/<repository>/http(s)://<hostname>/pages/<username>/<repository>/
Project site owned by organization accounthttp(s)://pages.<hostname>/<orgname>/<repository>/http(s)://<hostname>/pages/<orgname>/<repository>/

For more information, see "Enabling subdomain isolation" or contact your site administrator.

Publishing sources for Páginas de GitHub sites

The publishing source for your Páginas de GitHub site is the branch and folder where the source files for your site are stored.

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 it before publishing. For more information, see "Configuring Páginas de GitHub on your appliance" and "About repository visibility."

If the default publishing source exists in your repository, Páginas de GitHub will automatically publish a site from that source. The default publishing source for user and organization sites is the root of the default branch for the repository. The default publishing source for project sites is the root of the gh-pages branch.

If you want to keep the source files for your site in a different location, you can change the publishing source for your site. You can publish your site from any branch in the repository, either from the root of the repository on that branch, /, or from the /docs folder on that branch. For more information, see "Configuring a publishing source for your Páginas de GitHub site."

If you choose the /docs folder of any branch as your publishing source, Páginas de GitHub will read everything to publish your site from the /docs folder.

Static site generators

Páginas de GitHub publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. We recommend Jekyll, a static site generator with built-in support for Páginas de GitHub and a simplified build process. For more information, see "About Páginas de GitHub and Jekyll."

Páginas de GitHub will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called .nojekyll in the root of your publishing source, then follow your static site generator's instructions to build your site locally.

Páginas de GitHub does not support server-side languages such as PHP, Ruby, or Python.

Guidelines for using Páginas de GitHub

Páginas de GitHub sites are subject to the following usage limits:

  • Páginas de GitHub source repositories have a recommended limit of 1GB.
  • Published Páginas de GitHub sites may be no larger than 1 GB.

MIME types on Páginas de GitHub

A MIME type is a header that a server sends to a browser, providing information about the nature and format of the files the browser requested. Páginas de GitHub supports more than 750 MIME types across thousands of file extensions. The list of supported MIME types is generated from the mime-db project.

While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on Páginas de GitHub. For more information, see the mime-db contributing guidelines.

Further reading

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.