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.

Sintaxe básica de escrita e formatação no GitHub

Crie formatação sofisticada para narração e código no GitHub com sintaxe simples.

Neste artigo

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.

Títulos

Para criar um título, adicione de um a seis símbolos # antes do texto do título. O número de # que você usa determinará o tamanho do título.

# O título maior
## O segundo maior título
###### O título menor

Títulos H1, H2 e H6 renderizados

Estilizar texto

Você pode dar ênfase usando texto em negrito, itálico ou tachado.

EstiloSintaxeAtalhoExemploResultado
Negrito** ** ou __ __command/control + b**Esse texto está em negrito**Esse texto está em negrito
Itálico* * ou _ _command/control + i*Esse texto está em itálico*Esse texto está em itálico
Tachado~~ ~~~~Esse texto estava errado~~Esse texto estava errado
Negrito e itálico aninhado** ** e _ _**Esse texto é _extremamente_ importante**Esse texto é extremamente importante
Todo em negrito e itálico*** ******Todo esse texto é importante***Todo esse texto é importante

Citar texto

Você pode citar texto com um >.

Nas palavras de Abraham Lincoln:

> Pardon my French

Texto citado renderizado

Dica: ao exibir uma conversa, você pode citar textos automaticamente em um comentário destacando o texto e digitando r. É possível citar um comentário inteiro clicando em e em Quote reply (Resposta à citação). Para obter mais informações sobre atalhos de teclado, consulte "Atalhos de teclado".

Citar código

Você pode chamar código ou um comando em uma frase com aspas simples. O texto entre as aspas não será formatado.

Use 'git status' para listar todos os arquivos novos ou modificados que ainda não receberam commit.

Bloco de código inline renderizado

Para formatar código ou texto no próprio bloco distinto, use aspas triplas.

Alguns comandos Git básicos são:
```
git status
git add
git commit
```

Bloco de código renderizado

Para obter mais informações, consulte "Criar e destacar blocos de código".

Você pode criar um link inline colocando o texto do link entre colchetes [ ] e, em seguida, o URL entre parênteses ( ). Também é possível usar o atalho de teclado command + k para criar um link.

Este site foi construído usando [GitHub Pages](https://pages.github.com/).

Link renderizado

Dica: o GitHub Enterprise cria links automaticamente quando URLs válidos são escritos em um comentário. Para obter mais informações, consulte "Referências e URLs vinculados automaticamente".

Você pode vincular diretamente a uma seção de um arquivo interpretado, passando o mouse sobre o título da seção para expor o link:

Link da seção no arquivo LEIAME para o repositório github/scientist

É possível definir links relativos e caminhos de imagens em seus arquivos representados para ajudar os leitores a acessar outros arquivos no repositório.

Um link relativo é um link que é relativo ao arquivo atual. Por exemplo, se você tiver um arquivo LEIAME na raiz do seu repositório e tiver outro arquivo em docs/CONTRIBUTING.md, o link relativo para CONTRIBUTING.md no seu README pode se parecer com isso:

[Diretrizes de contribuição para este projeto](docs/CONTRIBUTING.md)

GitHub Enterprise transformará automaticamente o seu link relativo ou caminho da imagem baseado em qualquer branch em que você estiver no momento para que o link ou caminho sempre funcione. Você pode usar todas as operações de links relativos, como ./ e ../.

Os links relativos são mais fáceis para usuários que clonam o seu repositório. Os links absolutos podem não funcionar em clones do seu repositório - recomendamos usar links relativos para referir-se a outros arquivos no seu repositório.

Listas

Você pode criar uma lista não ordenada precedendo uma ou mais linhas de texto com - ou *.

- George Washington
- John Adams
- Thomas Jefferson

Lista não ordenada renderizada

Para ordenar a lista, coloque um número na frente de cada linha.

1. James Madison
2. James Monroe
3. John Quincy Adams

Lista ordenada renderizada

Listas aninhadas

Você pode criar uma lista aninhada recuando um ou mais itens da lista abaixo de outro item.

Para criar uma lista aninhada usando o editor web do GitHub Enterprise ou um editor de texto que usa uma fonte monoespaçada, como o Atom, você pode alinhar sua lista visualmente. Digite caracteres de espaço na fonte do item da lista aninhada, até que o caractere de marcador da lista (- ou *) fique diretamente abaixo do primeiro caractere do texto no item acima dele.

1. Primeiro item da lista
   - Primeiro item de lista aninhado
     - Segundo item de lista aninhada

Lista aninhada com alinhamento destacado

Lista com dois níveis de itens aninhados

Para criar uma lista aninhada no editor de comentários do GitHub Enterprise, que não usa uma fonte monoespaçada, você pode observar o item da lista logo acima da lista aninhada e contar o número de caracteres que aparecem antes do conteúdo do item. Em seguida, digite esse número de caracteres de espaço na fonte do item da linha aninhada.

Neste exemplo, você pode adicionar um item de lista aninhada abaixo do item de lista 100. Primeiro item da lista recuando o item da lista aninhada com no mínimo cinco espaços, uma vez que há cinco caracteres (100.) antes de Primeiro item da lista.

100. Primeiro item da lista
     - Primeiro item da lista aninhada

Lista com um item de lista aninhada

Você pode criar vários níveis de listas aninhadas usando o mesmo método. Por exemplo, como o primeiro item da lista aninhada tem sete espaços (␣␣␣␣␣-␣) antes do conteúdo da lista aninhada Primeiro item da lista aninhada, você precisaria recuar o segundo item da lista aninhada com sete espaços.

100. Primeiro item da lista
     - Primeiro item da lista aninhada
       - Segundo item da lista aninhada

Lista com dois níveis de itens aninhados

Para obter mais exemplos, consulte a Especificação de markdown em estilo GitHub.

Listas de tarefas

Para criar uma lista de tarefas, introduza os itens da lista com um caractere de espaço normal seguido de [ ]. Para marcar uma tarefa como concluída, use [x].

- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request

Lista de tarefas gerada

Se a descrição de um item da lista de tarefas começar com parênteses, você precisará usar \ para escape:

- [ ] \(Optional) Abrir um problema de acompanhamento

Para obter mais informações, consulte "Sobre listas de tarefas".

Mencionar pessoas e equipes

Você pode mencionar uma pessoa ou equipe no GitHub Enterprise digitando @ mais o nome de usuário ou nome da equipe. Isto desencadeará uma notificação e chamará a sua atenção para a conversa. As pessoas também receberão uma notificação se você editar um comentário para mencionar o respectivo nome de usuário ou da equipe. Para obter mais informações sobre notificações, consulte "Sobre as notificações".

@github/suporte O que você acha dessas atualizações?

@menção renderizada

Quando você menciona uma equipe principal, os integrantes de suas equipes secundárias também recebem notificações, simplificando a comunicação com vários grupos de pessoas. Para obter mais informações, consulte "Sobre equipes".

Digitar um símbolo @ chamará uma lista de pessoas ou equipes em um projeto. A lista é filtrada à medida que você digita. Portanto, assim que você achar o nome da pessoa ou da equipe que está procurando, use as teclas de seta para selecioná-lo e pressione tab ou enter para completar o nome. Para equipes, digite nome da @organização/equipe e todos os integrantes dessa equipe serão inscritos na conversa.

Os resultados do preenchimento automático são restritos aos colaboradores do repositório e qualquer outro participante no thread.

Fazer referências a problemas e pull requests

Você pode trazer à tona uma lista de problemas e pull requests sugeridos no repositório digitando #. Digite o número ou o título do problema ou da pull request para filtrar a lista e, em seguida, pressione tab ou enter para completar o resultado destacado.

Para obter mais informações, consulte "Referências e URLs vinculados automaticamente".

Fazer referência a recursos externos

Se as referências de link automático personalizado estão configuradas para um repositório, referências a recursos externos, como um problema do JIRA ou um ticket do Zendesk, serão convertidas em links encurtados. Para saber quais links automáticos estão disponíveis no repositório, entre em contato com alguém com permissões de administrador no repositório. Para obter mais informações, consulte "Configurar links automáticos para fazer referência a recursos externos".

Anexos de conteúdo

Alguns aplicativo GitHubs fornecem informações no GitHub Enterprise para URLs que são vinculados aos respectivos domínios registrados. O GitHub Enterprise renderiza as informações fornecidas pelo app sob o URL no texto ou comentário de um problema ou uma pull request.

Anexo de conteúdo

Para ver os anexos de conteúdo, é necessário ter um aplicativo GitHub que use a API de anexos de conteúdo instalada no repositório.

Os anexos de conteúdo não serão exibidos para URLs que fazem parte de um link markdown.

Para obter mais informações sobre como compilar um aplicativo GitHub que use anexos de conteúdo, consulte "Usar anexos de conteúdo".

Usar emoji

Você pode adicionar emoji à sua escrita digitando :EMOJICODE:.

@octocat :+1: Este PR parece ótimo - está pronto para o merge! :shipit:

Emoji renderizado

Digitar : trará à tona uma lista de emojis sugeridos. A lista será filtrada à medida que você digita. Portanto, assim que encontrar o emoji que estava procurando, pressione Tab ou Enter para completar o resultado destacado.

Para obter uma lista completa de emojis e códigos disponíveis, confira emoji-cheat-sheet.com.

Parágrafos

Você pode criar um parágrafo deixando uma linha em branco entre as linhas de texto.

Ignorar formatação markdown

Para informar ao GitHub Enterprise que deve ignorar a formatação markdown (ou usar escape nela), anteceda o caractere markdown com \.

Vamos renomear \*our-new-project\* para \*our-old-project\*.

Caractere com escape renderizado

Para obter mais informações, consulte "Sintaxe markdown" de Daring Fireball.

Leia mais

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.