Criar um site do GitHub Pages com o Jekyll

Neste artigo

• Pré-requisitos
• Criar um repositório para seu site
• Criar seu site
• Próximas etapas

Pessoas com permissões de administrador para um repositório podem criar um site do GitHub Pages com o Jekyll.

Pré-requisitos

Antes de poder usar o Jekyll para criar um site do GitHub Pages, você precisa instalar o Jekyll e o Git. Para obter mais informações, consulte Instalação na documentação do Jekyll e "Configurar o Git".

Recomendamos o uso do 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. To install Bundler:

1. Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
2. Instale o Bundler. For more information, see "Bundler."

Criar um repositório para seu 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.

1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

   

2. Use the Owner drop-down menu, and select the account you want to own the repository.

   

3. Digite um nome para o repositório e uma descrição opcional. If you're creating a user or organization site, your repository must be named <user>.github.io or <organization>.github.io. Para obter mais informações, consulte "Sobre o GitHub Pages".

   

4. Choose to make the repository either public or private. Public repositories are visible to everyone using sua instância do GitHub Enterprise Server, while private repositories are only accessible to you, and people you share them with. Para obter mais informações, consulte "Configurar visibilidade do repositório".

   

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

1. Open TerminalTerminalGit Bash.

2. Se você ainda não tem uma cópia do seu repositório, navegue até o local onde deseja armazenar os arquivos de origem do seu site, substituindo PARENT-FOLDER pela pasta que deverá conter a pasta do repositório.

   $ cd PARENT-FOLDER

3. Caso você ainda não o tenha feito, inicialize um repositório Git local, substituindo REPOSITORY-NAME pelo nome do seu repositório.

   $ git init REPOSITORY-NAME
   > Initialized empty Git repository in /Users/octocat/my-site/.git/
   # Cria uma nova pasta no seu computador, inicializada como um repositório Git

4. Altere os diretórios no repositório.

   $ cd REPOSITORY-NAME
   # Altera o diretório de trabalho

5. 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 GitHub Pages."

6. Navigate to the publishing source for your site. Para obter mais informações sobre fontes de publicação, consulte "Sobre o GitHub Pages".

   Por exemplo, se você optou por publicar seu site a partir da pasta docs no branch master, crie e altere diretórios na pasta docs.

   $ mkdir docs
   # Cria uma nova pasta chamada docs
   $ cd docs

   Se você optou por publicar seu site a partir do branch gh-pages, crie e faça checkout do branch gh-pages.

   $ git checkout --orphan gh-pages
   # Cria um novo branch, sem histórico ou conteúdo, chamado gh-pages e alterna para o branch gh-pages

7. Para criar um novo site do Jekyll, use o comando jekyll new, substituindo VERSION pela versão atual de dependências do Jekyll. Para obter mais informações, consulte "Versões de dependências" no site do GitHub Pages.

   • Se você instalou o bundler:

     $ bundle exec jekyll VERSION new .
     # Cria um site do Jekyll no diretório atual

   • Se você não tem o bundler instalado:

     $ jekyll VERSION new .
     # Cria um site do Jekyll no diretório atual

8. Abra o Gemfile que foi criado e siga as instruções nos comentários do Gemfile para usar o GitHub Pages.

   

9. Para que a linha gem "github-pages" fique com a aparência mostrada a seguir, atualize-a substituindo VERSION pela versão atual de dependências para github-pages. Para obter mais informações, consulte "Versões de dependências" no site do GitHub Pages.

   gem "github-pages", "~> VERSION", group: :jekyll_plugins

10. Salve e feche o Gemfile.

11. Como alternativa, teste seu site localmente. Para obter mais informações, consulte "Testar seu site do GitHub Pages localmente com o Jekyll".

12. Adicione seu repositório do GitHub Enterprise como um remote, substituindo HOSTNAME pelo nome de host do appliance USER pela conta a que pertence o repositório e REPOSITORY pelo nome do repositório.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    

13. Faça push no repositório para o GitHub Enterprise, substituindo BRANCH pelo nome do branch em que você está trabalhando.

    $ git push -u origin BRANCH

14. If you're using a non-default publishing source for a project site, configure your publishing source. Para obter mais informações, consulte "Configurar uma fonte de publicação para seu site do GitHub Pages".

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

16. Under your repository name, click Settings.

    

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

    

    Observação: podem ser necessários até 20 minutos para que as alterações no site sejam publicadas após o push delas no GitHub Enterprise. If your don't see your changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

Próximas etapas

Para adicionar uma nova página ou postagem ao seu site, consulte "Adicionar conteúdo ao site do GitHub Pages usando o Jekyll".

You can add a Jekyll theme to your GitHub Pages site to customize the look and feel of your site. Para obter mais informações, consulte "Adicionar um tema ao site do GitHub Pages usando o Jekyll".