Skip to main content

Creating a GitHub Pages site with Jekyll

You can use Jekyll to create a GitHub Pages site in a new or existing repository.

Who can use this feature

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, confira "produtos de GitHub".

Observação: os proprietários da organização podem restringir a publicação de sites do GitHub Pages em repositórios pertencentes à organização. Para obter mais informações, confira "Como gerenciar a publicação de sites do GitHub Pages".

Prerequisites

Before you can use Jekyll to create a GitHub Pages site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and "Set up 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.

Creating a repository for your 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

Se a conta que é o proprietário do repositório usar o GitHub Free ou o GitHub Free para organizações, o repositório precisará ser público.

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

  2. Use o menu suspenso Proprietário e selecione a conta que você deseja que seja proprietária do repositório. Menu suspenso Proprietário

    Note: If you're a managed user account, you can only publish GitHub Pages sites from repositories owned by organizations. For more information, see "About GitHub Pages."

  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". Campo Criar repositório

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

Creating your site

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

Aviso: a menos que sua empresa use Enterprise Managed Users, sites de GitHub Pages estarão disponíveis publicamente na Internet por padrão, mesmo que o repositório para o site seja privado ou interno. Você pode publicar um site de forma privada gerenciando o controle de acesso para o site. Caso contrário, se você tiver dados confidenciais no repositório do seu site, talvez queira remover os dados antes da publicação. Para obter mais informações, confira "Sobre repositórios" e "Alterar a visibilidade de seu site GitHub Pages".

  1. Abra TerminalTerminalGit Bash.

  2. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing PARENT-FOLDER with the folder you want to contain the folder for your repository.

    $ cd PARENT-FOLDER
  3. If you haven't already, initialize a local Git repository, replacing REPOSITORY-NAME with the name of your repository.

    $ 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. Change directories to the repository.

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

  6. 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." For example, if you chose to publish your site from the docs folder on the default branch, create and change directories to the docs folder.

    $ 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. To create a new Jekyll site, use the jekyll new command:

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
  8. Open the Gemfile that Jekyll created.

  9. Add "#" to the beginning of the line that starts with gem "jekyll" to comment out this line.

  10. Add the github-pages gem by editing the line starting with # gem "github-pages". Change this line to:

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

    Replace GITHUB-PAGES-VERSION with the latest supported version of the github-pages gem. You can find this version here: "Dependency versions."

    The correct version Jekyll will be installed as a dependency of the github-pages gem.

  11. Save and close the Gemfile.

  12. From the command line, run bundle install.

  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. Optionally, test your site locally. For more information, see "Testing your GitHub Pages site locally with Jekyll."

  15. Add and commit your work.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  16. Add your repository on GitHub.com as a remote, replacing USER with the account that owns the repository and REPOSITORY with the name of the repository.

    $ git remote add origin https://github.com/USER/REPOSITORY.git
    
  17. Push the repository to GitHub Enterprise Cloud, replacing BRANCH with the name of the branch you're working on.

    $ git push -u origin BRANCH
  18. 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".

  19. Em GitHub Enterprise Cloud, acesse o repositório do seu site.

  20. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório

  21. In the "Code and automation" section of the sidebar, click Pages.

  22. Opcionalmente, para publicar um site de projeto de um repositório privado ou interno, escolha a visibilidade do seu site. Em "GitHub Pages", selecione o menu suspenso Visibilidade do GitHub Pages e clique em uma visibilidade. Para obter mais informações, confira "Como alterar a visibilidade do seu site do GitHub Pages". Menu suspenso para selecionar visibilidade para o seu site

    Observação: para publicar um site do GitHub Pages de modo privado, sua organização precisa usar o GitHub Enterprise Cloud. Para obter mais informações sobre como você pode experimentar o GitHub Enterprise Cloud gratuitamente, confira "Como configurar uma avaliação do GitHub Enterprise Cloud".

  23. 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 Enterprise Cloud. 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".

  24. Seu site GitHub Pages está integrado e foi implantado com um fluxo de trabalho GitHub Actions. Para obter mais informações, confira "Exibir o histórico de execuções de fluxo de trabalho".

    Observação: o GitHub Actions é gratuito para repositórios públicos. Os encargos de uso se aplicam a repositórios privados e internos que vão além do loteamento mensal de minutos gratuitos. Para obter mais informações, confira "Limites de uso, cobrança e administração".

Observação: se você estiver publicando de um branch e 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.

Next steps

To add a new page or post to your site, see "Adding content to your GitHub Pages site using Jekyll."

É possível adicionar um tema do Jekyll ao site do GitHub Pages para personalizar a aparência do seu site. For more information, see "Adding a theme to your GitHub Pages site using Jekyll."