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

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 a armazenar os arquivos de origem do site ou usar um fluxo de trabalho personalizado do GitHub Actions para criar e implantar os arquivos de origem do site. Arquivos do Para usar o GitHub Actions como uma fonte de publicação de GitHub Pages, um administrador do site precisa habilitar o GitHub Actions para GitHub Enterprise Server. Para obter mais informações, confira "Habilitar GitHub Actions para o GitHub Enterprise Server".

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, selecione e clique em Novo repositório.

   

2. Use o menu suspenso Proprietário para selecionar a conta que deseja atribuir como proprietário 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 repositórios".

Criar seu 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. 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 /REPOSITORY-NAME/.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 "Configurar uma fonte de publicação para o site do GitHub Pages".

6. Navegue até a fonte de publicação do seu site. Para obter mais informações, confira "Configurar uma fonte de publicação para o 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
   

   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. Para criar um site do Jekyll, use o comando jekyll new no diretório raiz do repositório:

   $ jekyll new --skip-bundle .
   # Creates a Jekyll site in the current directory
   

8. Abra o Gemfile que o Jekyll criou.

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

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

11. Salve e feche o Gemfile.

12. Da linha de comando, execute bundle install.

13. Abra o arquivo .gitignore que o Jekyll criou e ignore o arquivo de bloqueio de gemas adicionando esta linha:

    Gemfile.lock
    

14. 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 saber mais, confira 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
    

15. Como alternativa, teste seu site localmente. Para obter mais informações, confira Como testar seu site do GitHub Pages localmente com o Jekyll.

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

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
    

17. Adicione seu repositório ao sua instância do GitHub Enterprise Server 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
    
    

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

    git push -u origin BRANCH
    

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

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

21. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    

22. Na seção "Código e automação" da barra lateral, clique em Páginas.

23. Para ver o site publicado, em "GitHub Pages", clique em Visitar site.

    

    Note

    Poderá levar até 10 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 de GitHub Pages não forem refletidas no navegador após uma hora, confira "Sobre erros de criação do Jekyll para sites do GitHub Pages".

Próximas etapas

Para adicionar uma nova página ou postagem ao seu site, confira Adicionar conteúdo ao 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 saber, confira Adicionar um tema ao site do GitHub Pages usando Jekyll.