Skip to main content

Criar um site do GitHub Pages com o Jekyll

É possível usar o Jekyll para criar um site do GitHub Pages em um repositório novo ou existente.

Who can use this feature

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

O GitHub Pages está disponível em repositórios internos e privados com o GitHub AE. GitHub Pages está disponível em repositórios públicos com GitHub Free e GitHub Free para organizações, e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server.

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, confira Instalação na documentação do Jekyll e "Configurar o 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".

Dica: caso você receba um erro do Ruby ao tentar instalar o Jekyll usando o Bundler, talvez seja necessário usar um gerenciador de pacotes, como o RVM ou o Homebrew, para gerenciar a instalação do Ruby. Para obter mais informações, confira "Solução de problemas" na documentação do Jekyll.

Criar um repositório para seu 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. Menu suspenso com a opção para criação de um repositório 1. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório. Menu suspenso Proprietário 1. 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". Campo Criar repositório 1. Escolha uma visibilidade do repositório. Para obter mais informações, confira "Sobre os repositórios". Botões de opção usados para selecionar a visibilidade do repositório

Criar seu site

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

Aviso: sites GitHub Pages ficam visíveis para todos os membros da empresa, mesmo que o repositório do site seja privado. Se você tiver dados confidenciais no repositório do seu site, poderá removê-los antes de publicá-los. Para obter mais informações, confira "Sobre os repositórios".

  1. Abra TerminalTerminalGit Bash.

  2. Se você ainda não tem uma cópia do seu repositório, procure o local em que 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 tenha feito isso, 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/
    # Creates a new folder on your computer, initialized as a Git repository
  4. Altere os diretórios no repositório.

    $ 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." 1. 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." Por exemplo, se você optar por publicar seu site por meio da pasta docs no branch padrão, crie e altere os diretórios para a pasta docs.

    $ mkdir docs
    # Creates a new folder called docs
    $ cd docs

    Se você optar por publicar seu site no branch gh-pages, crie o branch gh-pages e faça check-out dele.

    $ 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
  6. Para criar um site do Jekyll, use o comando jekyll new:

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
  7. Abra o Gemfile que o Jekyll criou.

  8. Adicione "#" ao início da linha que começa com gem "jekyll" para remover o comentário dessa linha.

  9. Adicione o gem github-pages editando a linha que começa com # gem "github-pages". Mudar esta linha para:

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

    Substitua GITHUB-PAGES-VERSION pela última versão compatível do gem github-pages. Encontre esta versão aqui: "Versões de dependência".

    A versão correta do Jekyll será instalada como uma dependência do gem github-pages.

  10. Salve e feche o Gemfile.

  11. Da linha de comando, execute bundle install.

  12. Opcionalmente, faça as edições necessárias no arquivo _config.yml. Isto é necessário para caminhos relativos quando o repositório é hospedado em um subdiretório. Para obter mais informações, confira "Como dividir uma subpasta em um novo repositório".

    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
    
  13. Como alternativa, teste seu site localmente. Para obter mais informações, confira "Como testar seu site do GitHub Pages localmente com o Jekyll".

  14. Adicione e faça commit do seu trabalho.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  15. Adicione seu repositório no GitHub AE como um repositório remoto, substituindo HOSTNAME pelo nome do host da sua empresa, USER pela conta à qual o repositório pertence, e REPOSITORY pelo nome do repositório.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    
  16. Faça push no repositório para o GitHub AE, substituindo BRANCH pelo nome do branch em que você está trabalhando.

    $ git push -u origin BRANCH
  17. 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". 1. Em GitHub AE, acesse o repositório do seu site. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório

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

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

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

Observação: If seu site não tiver sido publicado automaticamente, verifique se alguém com permissões de administrador e um endereço de email verificado efetuou push para a fonte de publicação.

Próximas etapas

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

É possível adicionar um tema do Jekyll ao site do GitHub Pages para personalizar a aparência do seu site. Para obter mais informações, confira "Como adicionar um tema ao seu site do GitHub Pages usando o Jekyll".