Esta versão do GitHub Enterprise foi descontinuada em 2021-06-09. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

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.

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

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, 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. Para instalar o bundler:

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

Dica: se vir um erro do Ruby ao tentar instalar o Jekyll usando o Bundler, talvez você precise usar um gerenciador de pacotes, como o RVM ou Homebrew, para gerenciar a instalação do Ruby. Para obter mais informações, consulte "Solução de problemas" na documentação do Jekyll.

Criar um repositório para seu site

Se o seu site for um projeto independente, você pode criar um novo repositório para armazenar o código-fonte do seu site. Se o seu site estiver associado a um projeto existente, você pode adicionar o código-fonte a esse repositório do projeto, em uma pasta de /docs no branch padrão ou em um branch diferente. Por exemplo, se você estiver criando um site para publicar a documentação de um projeto que já está em GitHub Enterprise Server, você deverá armazenar o código-fonte para o site no mesmo repositório do projeto.

Se você deseja criar um site em um repositório existente, pule para a seção "Criar o 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 de criar um novo repositório
  2. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório. Menu suspenso Owner (Proprietário)
  3. Digite um nome para o repositório e uma descrição opcional. Se você estiver criando um site de usuário ou organização, o seu repositório deve ser denominado <user>.github.io ou <organization>.github.io. Para obter mais informações, consulte "Sobre GitHub Pages". Campo Create repository (Criar repositório)
  4. Escolha uma visibilidade do repositório. Para obter mais informações, consulte "Sobre a visibilidade do repositório." Botões de opção 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 Enterprise Server. Se você não estiver criando o site em um repositório existente, consulte "Criar um repositório para o site".

Aviso: Se o administrador do site tiver ativado páginas públicas, GitHub Pages sites estão disponíveis publicamente na internet, Mesmo que o repositório para o site seja privado ou interno. Se tiver dados confidenciais no repositório do seu site, poderá remover os dados antes de publicar. For more information, see "Configuring GitHub Pages for your enterprise" and "About repository visibility."

  1. Abra 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. Decida qual fonte de publicação você deseja usar. Para obter mais informações, consulte "Sobre GitHub Pages".

  6. Navegue até a fonte de publicação do seu site. Para obter mais informações sobre fontes de publicação, consulte "Sobre o GitHub Pages". Por exemplo, se você escolheu publicar o seu site a partir da pasta documentação no branch-padrão, crie e altere os diretórios na pasta documentação.

    $ 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:

    $ jekyll new .
    # Cria um site do Jekyll no diretório atual
  8. Abra o Gemfile que o Jekyll criou.

  9. Adicione "#" ao início da linha que começa com gem "jekyll" para comentar nesta 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-VERSÃO pela última versão compatível do gem de github-pages. Você pode encontrar esta versão aqui: "Versões de dependência".

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

  11. Salve e feche o Gemfile.

  12. Na linha de comando, execute atualização do pacote.

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

  15. Add and commit your work.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  16. Adicione seu repositório GitHub Enterprise Server como um remoto, substituindo HOSTNAME pelo nome de host da sua empresa, USUÁRIO pela conta proprietária do repositório, e REPOSITÓRIO pelo nome do repositório.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    
  17. 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
  18. Configure a sua fonte de publicação. Para obter mais informações, consulte "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. No nome do seu repositório, clique em Configurações. Botão de configurações do repositório

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

    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 Server. Se você não vir suas alterações no navegador após uma hora, consulte "Sobre erros de criação do Jekyll para sites de GitHub Pages".

Observação: Se os arquivos de origem de do site estão localizados na fonte de publicação padrão —mestre para sites de usuário e organização ou gh-pages para sites de projeto — mas seu site não fez a publicação automaticamente, certifique-se de que alguém com permissões de administrador e um endereço de e-mail verificado tenha feito push para a fonte de publicação.

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

É 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, consulte "Adicionar um tema ao site do GitHub Pages usando o Jekyll".