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

Recomendamos usar o Bundler para instalar e executar o Jekyll. O Bundler gerencia as dependências do gem do Ruby, reduz os erros de compilação do Jekyll e evita erros relacionados ao ambiente. Para instalar o bundler:

1. Instale o Ruby. Para obter mais informações, confira "Como instalar o Ruby" na documentação do Ruby.
2. Instale o Bundler. Para obter mais informações, confira "Bundler".

Creating a repository for your site

Você pode criar um repositório ou escolher um repositório existente para seu site.

Se você quiser criar um site do GitHub Pages para um repositório em que nem todos os arquivos do repositório estejam relacionados ao site, você poderá configurar uma fonte de publicação para seu site. Por exemplo, você pode ter um branch e uma pasta dedicados para armazenar os arquivos de origem do seu site.

Caso deseje criar um site em um repositório existente, vá para a seção "Como criar seu site".

1. No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório.
2. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório.
3. Digite um nome para o repositório e uma descrição opcional. Se você estiver criando um site de usuário ou de organização, seu repositório precisará ser chamado <user>.github.io ou <organization>.github.io. Se o nome do usuário ou da organização contiver letras maiúsculas, você precisará colocá-las em minúsculas. Para obter mais informações, confira "Sobre o GitHub Pages".
4. Escolha uma visibilidade do repositório. Para obter mais informações, confira "Sobre os repositórios".

Creating your site

Antes de criar seu site, você deve ter um repositório para seu site no GitHub Enterprise Server. Se você não estiver criando seu site em um repositório existente, confira "Criar um repositório para seu site".

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. Decida qual fonte de publicação você deseja usar. Para obter mais informações, confira "Como configurar uma fonte de publicação para o seu site do GitHub Pages."

6. Navegue até a fonte de publicação do seu site. Para obter mais informações, confira "Como configurar uma fonte de publicação para o seu site do 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 your GitHub Enterprise Server instance as a remote, replacing HOSTNAME with your enterprise'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
    

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

    $ git push -u origin BRANCH

18. Configure a sua fonte de publicação. Para obter mais informações, confira "Como configurar uma fonte de publicação para seu site do GitHub Pages".

19. Em GitHub Enterprise Server, acesse o repositório do seu site.

20. Abaixo do nome do repositório, clique em Configurações.

21. In the left sidebar, click Pages.

22. Para ver seu site publicado, em "GitHub Pages", clique na URL do seu site.

    Observação: poderá levar até dez minutos para que as alterações no seu site sejam publicadas depois que você efetuar push das alterações para o GitHub Enterprise Server. Se as alterações no site do GitHub Pages não forem refletidas no navegador após uma hora, confira "Sobre os erros de build do Jekyll em sites do GitHub Pages".

Next steps

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

É possível adicionar um tema do Jekyll ao site do GitHub Pages para personalizar a aparência do seu site. For more information, see "Adding a theme to your GitHub Pages site using Jekyll."