Creating a GitHub Pages site with Jekyll
You can use Jekyll to create a Páginas de GitHub site in a new or existing repository.
Páginas de GitHub se encuentra disponible en repositorios públicos con GitHub gratis y en repositorios privados y públicos con GitHub Pro, Equipo de GitHub, Nube de GitHub Enterprise y Servidor de GitHub Enterprise.
People with admin permissions for a repository can create a Páginas de GitHub site with Jekyll.
En este artículo
Prerrequisitos
Before you can use Jekyll to create a Páginas de GitHub site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and "Set up Git."
We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:
- Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
- Install Bundler. For more information, see "Bundler."
Tip: If you see a Ruby error when you try to install Jekyll using Bundler, you may need to use a package manager, such as RVM or Homebrew, to manage your Ruby installation. For more information, see "Troubleshooting" in the Jekyll documentation.
Creating a repository for your site
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.
-
En la esquina superior derecha de cualquier página, haz clic en y, luego, haz clic en Nuevo repositorio.
-
Usa el menú desplegable Propietario y selecciona la cuenta que deseas que sea la propietaria del repositorio.
-
Type a name for your repository and an optional description. If you're creating a user or organization site, your repository must be named
<user>.github.io
or<organization>.github.io
. For more information, see "About Páginas de GitHub." -
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. For more information, see "Setting repository visibility."
Creating your site
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."
-
Abre el terminal TerminalTerminalGit Bash.
-
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
-
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
-
Change directories to the repository.
$ cd REPOSITORY-NAME# Changes the working directory
-
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." -
Navigate to the publishing source for your site. For more information about publishing sources, see "About Páginas de GitHub."
For example, if you chose to publish your site from the
docs
folder on themaster
branch, create and change directories to thedocs
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 thegh-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
-
To create a new Jekyll site, use the
jekyll new
command, replacing VERSION with the current dependency version for Jekyll. For more information, see "Dependency versions" on the Páginas de GitHub site.-
If you installed Bundler:
$ bundle exec jekyll VERSION new . # Creates a Jekyll site in the current directory
-
If you don't have Bundler installed:
$ jekyll VERSION new . # Creates a Jekyll site in the current directory
-
-
Open the Gemfile that was created and follow the instructions in the Gemfile's comments to use Páginas de GitHub.
-
Update the
gem "github-pages"
line so that the line looks like this, replacing VERSION with the current dependency version forgithub-pages
. For more information, see "Dependency versions" on the Páginas de GitHub site.gem "github-pages", "~> VERSION", group: :jekyll_plugins
-
Save and close the Gemfile.
-
Optionally, test your site locally. For more information, see "Testing your Páginas de GitHub site locally with Jekyll."
-
Add your GitHub Enterprise repository as a remote, replacing HOSTNAME with your appliance's hostname, USER with the account that owns the repository, and REPOSITORY with the name of the repository.
$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
-
Push the repository to GitHub Enterprise, replacing BRANCH with the name of the branch you're working on.
$ git push -u origin BRANCH
-
If you're using a non-default publishing source for a project site, configure your publishing source. For more information, see "Configuring a publishing source for your Páginas de GitHub site."
-
On GitHub Enterprise, navigate to your site's repository.
-
En el nombre de tu repositorio, haz clic en Parámetros.
-
To see your published site, under "Páginas de GitHub", click your site's URL.
Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to 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."
Note: If your site's source files are located in the default publishing source—master
for user and organization sites or gh-pages
for project sites—but your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the default publishing source.
Pasos siguientes
To add a new page or post to your site, see "Adding content to your Páginas de GitHub site using Jekyll."
You can add a Jekyll theme to your Páginas de GitHub site to customize the look and feel of your site. For more information, see "Adding a theme to your Páginas de GitHub site using Jekyll."