Criar uma página 404 para o site do GitHub Pages

Você pode exibir uma página de erro 404 personalizada quando as pessoas tentam acessar páginas não existentes no seu site.

Quem pode usar esse recurso?

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

O GitHub Pages agora usa o GitHub Actions para executar a compilação Jekyll. Ao usar uma ramificação como a origem da sua compilação, o GitHub Actions deverá estar habilitado em seu repositório se você quiser usar o fluxo de trabalho interno do Jekyll. Como alternativa, se o GitHub Actions não estiver disponível ou estiver desabilitado, adicionar um .nojekyll arquivo à raiz da ramificação de origem ignorará o processo de compilação do Jekyll e implantará o conteúdo diretamente. Para mais informações sobre ativar o GitHub Actions, confira Gerenciando as configurações do GitHub Actions para um repositório.

  1. No GitHub, acesse o repositório do seu site.

  2. Navegue até a fonte de publicação do seu site. Para saber mais, confira Configurar uma fonte de publicação para o site do GitHub Pages.

  3. Acima da lista de arquivos, selecione o menu suspenso Add file e clique em Create new file.

    Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

    Captura de tela da página principal de um repositório realçando "Add file" e o ícone de "sinal de adição", descrito acima, com um contorno laranja.

  4. No campo Nome do arquivo, insira 404.html ou 404.md.

  5. Se você deu ao arquivo o nome 404.md, adicione o seguinte front matter YAML no começo do arquivo:

    ---
permalink: /404.html
---

  6. Abaixo da página inicial YAML, se houver, adicione o conteúdo que deseja exibir na página 404.

  7. Clique em Fazer commit das alterações...

  8. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para saber mais, confira Criar um commit com vários autores.

  9. Se você tiver mais de um endereço de email associado à sua conta em GitHub, clique no menu suspenso do endereço de email e selecione o email a ser usado como o endereço de email do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você habilitou a privacidade do endereço de email, um email sem resposta será o endereço de email do autor de commit padrão. Para obter mais informações sobre a forma exata que o endereço de email sem resposta pode assumir, confira Configurar o endereço de e-mail do commit.

    Captura de tela de uma solicitação de pull do GitHub que mostra um menu suspenso com opções para escolher o endereço de email do autor do commit. octocat@github.com está selecionado.

  10. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de uma solicitação de pull do GitHub que mostra um botão de opção para fazer commit diretamente na ramificação principal ou para criar um branch. O novo branch está selecionado.

  11. Clique em Fazer commit de alterações ou em Propor alterações.

Leitura adicional