Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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. Para obter mais informações, consulte os "produtos do GitHub".

Observação: Os proprietários da organização podem restringir a publicação de sites de GitHub Pages de repositórios pertencentes à organização. Para obter mais informações, consulte "Gerenciar a publicação de sites de GitHub Pages".

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. If your site is associated with an existing project, you can add the source code to that project's repository, in a /docs folder on the default branch or on a different branch. For example, if you're creating a site to publish documentation for a project that's already on GitHub, you may want to store the source code for the site in the same repository as the project.

If the account that owns the repository uses GitHub Free or GitHub Free for organizations, the repository must be public.

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. If your user or organization name contains uppercase letters, you must lowercase the letters. 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 repositórios". 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. Se você não estiver criando o site em um repositório existente, consulte "Criar um repositório para o site".

Aviso: GitHub Pages sites are publicly available on the internet, even if the repository for the site is private. If you have sensitive data in your site's repository, you may want to remove the data before publishing. Para obter mais informações, consulte "Sobre repositórios".

  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. Decide which publishing source you want to use. For more information, see "About 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
    # 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 novo site do Jekyll, use o comando jekyll new:

    $ jekyll new --skip-bundle .
    # 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. Da linha de comando, execute bundle install.

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

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

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  16. Adicione o seu repositório em GitHub.com como remoto, substituindo USUÁRIO pela conta à qual o repositório pertence e REPOSITÓRIO pelo nome do repositório.

    $ git remote add origin https://github.com/USER/REPOSITORY.git
    
  17. Faça push no repositório para o GitHub, 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, 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. In the "Code and automation" section of the sidebar, click Pages.

  22. 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é 10 minutos para que as alterações no site sejam publicadas após o push delas no GitHub. If you don't see your GitHub Pages site changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

  23. If your GitHub Pages site is built from a public repository, it is built and deployed with a GitHub Actions workflow run unless you've configured your GitHub Pages site to use a different CI tool. For more information about how to view the workflow status, see "Viewing workflow run history."

Note: GitHub Actions workflow runs for your GitHub Pages sites are in public beta for public repositories and subject to change. GitHub Actions workflow runs are free for public repositories.

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

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