Creating a GitHub Pages site with Jekyll

You can use Jekyll to create a GitHub Pages site in a new or existing repository.

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

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

Note: Organization owners can restrict the publication of GitHub Pages sites from repositories owned by the organization. For more information, see "Managing the publication of GitHub Pages sites."


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

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:

  1. Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
  2. 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 to that project's repository, in a /docs folder on the default branch or on a different branch. For example, if you're creating a site to publish documentation for a project that's already on GitHub Enterprise Cloud, you may want to store the source code for the site in the same repository as the project.

If the account that owns the repository uses GitHub Free or GitHub Free for organizations, the repository must be public.

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. Drop-down with option to create a new repository
  2. Use the Owner drop-down menu, and select the account you want to own the repository. Owner drop-down menu
  3. 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> or <organization> If your user or organization name contains uppercase letters, you must lowercase the letters. For more information, see "About GitHub Pages." Create repository field
  4. Choose a repository visibility. For more information, see "About repositories." Radio buttons to select repository visibility

Creating your site

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

Warning: GitHub Pages sites are publicly available on the internet by default, even if the repository for the site is private or internal. If your project site is published from a private or internal repository owned by an organization using GitHub Enterprise Cloud, you can manage access control for the site. In an enterprise with managed users, all GitHub Pages sites are privately published. Otherwise, if you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "About repositories" and "Changing the visibility of your GitHub Pages site."

  1. Open 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.

  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.

    # Changes the working directory
  5. Decide which publishing source you want to use. For more information, see "About GitHub Pages."

  6. Navigate to the publishing source for your site. For more information about publishing sources, see "About 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
  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:       # if you want to force HTTPS, specify the domain without the http at the start, e.g.
    url:  # the base hostname and protocol for your site, e.g.
    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 as a remote, replacing USER with the account that owns the repository and REPOSITORY with the name of the repository.

    $ git remote add origin
  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. Configure your publishing source. For more information, see "Configuring a publishing source for your GitHub Pages site."

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

  20. Under your repository name, click Settings. Repository settings button

  21. In the left sidebar, click Pages. Page tab in the left-hand sidebar

  22. Optionally, if you're publishing a project site from a private or internal repository owned by an organization using GitHub Enterprise Cloud, choose the visibility for your site. Under "GitHub Pages", select the GitHub Pages visibility drop-down menu, then click a visibility. For more information, see "Changing the visibility of your GitHub Pages site". Drop-down to select visibility for your site

  23. To see your published site, under "GitHub Pages", click your site's URL. URL of your published site

    Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to GitHub Enterprise Cloud. If your don't see your changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

Next steps

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

You can add a Jekyll theme to your GitHub Pages site to customize the look and feel of your site. For more information, see "Adding a theme to your GitHub Pages site using Jekyll."

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

Or, learn how to contribute.