Headings

To create a heading, add one to six # symbols before your heading text. O número de # que utilizar determinará o tamanho da posição.

# The largest heading## The second largest heading###### The smallest heading

Styling text

pode indicar ênfase com texto a negrito, itálico ou strikethrough.

citando texto

pode citar texto com um >.,

In the words of Abraham Lincoln:> Pardon my French

Tip: ao ver uma conversa, pode citar automaticamente o texto num comentário, realçando o texto, depois escrevendo r. Você pode citar um comentário inteiro clicando, em seguida, citar a resposta. Para mais informações sobre atalhos de teclado, consulte “Atalhos de teclado.”

citando o código

você pode invocar o código ou um comando dentro de uma frase com um único verso. O texto dentro dos backticks não será formatado.,

Use `git status` to list all new or modified files that haven't yet been committed.

para formatar o código ou o texto no seu próprio bloco distinto, utilize ripas triplas.

Some basic Git commands are:```git statusgit addgit commit```

para mais informações, veja “criação e realce de blocos de código.”

Links

você pode criar uma ligação em linha, embrulhando o texto da ligação entre parênteses , e depois embrulhando o URL entre parênteses ( ). Você também pode usar o atalho de teclado command + k para criar uma ligação.,

This site was built using (https://pages.github.com/).

Sugestão: o GitHub cria automaticamente ligações quando URLs válidos são escritos em um comentário. Para mais informações, consulte ” Referências e URLS autenticadas.”

Seção de links

Você pode ligar diretamente para uma seção em uma renderizado do arquivo ao passar o mouse sobre o cabeçalho de seção para expor o link:

Relativo links

Você pode definir links relativos e caminhos de imagem em sua renderização de arquivos para ajudar os leitores a navegar para outros arquivos no seu repositório.,

uma ligação relativa é uma ligação que é relativa ao ficheiro actual. Por exemplo, se você tem um arquivo README no diretório raiz do seu repositório, e você tem um outro arquivo no docs/CONTRIBUIR.md, o vínculo relativo a CONTRIBUIR.md no README pode se parecer com isto:

(docs/CONTRIBUTING.md)

GitHub vai automaticamente transformar o seu link relativo ou um caminho de imagem com base em qualquer ramo que você está no momento, para que o link ou caminho sempre funciona. Você pode usar todos os operandos de ligação relativos, tais como ./ e ../.,

As ligações relativas são mais fáceis para os utilizadores que clonam o seu repositório. Links absolutos podem não funcionar em clones do seu repositório – recomendamos o uso de links relativos para se referir a outros arquivos dentro do seu repositório.

listas

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

- George Washington- John Adams- Thomas Jefferson

Para encomendar a sua lista, preceder cada linha com um número.,

1. James Madison2. James Monroe3. John Quincy Adams

Listas Aninhadas

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

para criar uma lista aninhada usando o editor web no GitHub ou um editor de texto que usa um tipo de letra monoespaçado, como o Atom, poderá alinhar a sua lista visualmente. Escreva os caracteres de espaço à frente do item da sua lista aninhada, até que o carácter marcador da lista (- ou *) esteja directamente abaixo do primeiro carácter do texto no item acima.,

1. First list item - First nested list item - Second nested list item

Para criar uma lista aninhada no comentário do editor no GitHub, o que não usar uma fonte monoespaçada, você pode olhar para a lista item imediatamente 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 frente do item da lista aninhada.,

neste exemplo, você pode adicionar uma lista aninhada item sob o item de lista 100. First list item pelo recuo de lista aninhada item de um mínimo de cinco espaços, desde há cinco caracteres () antes de First list item.

100. First list item - First nested list item

Você pode criar vários níveis de listas aninhadas usando o mesmo método., Por exemplo, porque o primeiro item da lista aninhada tem sete espaços (␣␣␣␣␣-␣) antes do conteúdo da lista aninhada First nested list item, Você teria de indentar o segundo item da lista aninhado por sete espaços.

100. First list item - First nested list item - Second nested list item

para mais exemplos, ver a especificação de marcação com sabor a GitHub.

listas de Tarefas

para criar uma lista de Tarefas, prefácio lista de itens com um carácter de espaço regular seguido por . Para marcar uma tarefa como completa, use .,

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

Se uma lista de tarefas descrição do item começa com um parêntese, você precisa escapar com \:

- \(Optional) Open a followup issue

Para mais informações, consulte “Sobre listas de tarefas.”

mencionando pessoas e equipas

pode mencionar uma pessoa ou equipa no GitHub escrevendo @ mais o seu nome de utilizador ou de equipa. Isto vai despoletar uma notificação e chamar a atenção deles para a conversa., As pessoas também receberão uma notificação se você editar um comentário para mencionar o seu nome de usuário ou de equipe. Para mais informações sobre notificações, consulte ” Sobre notificações.”

@github/support What do you think about these updates?

Quando você mencionar o pai de equipe, os membros da sua criança equipes, também, receber notificações, facilitar a comunicação com vários grupos de pessoas. Para mais informações, consulte ” About teams.”

dactilografar um símbolo

trará uma lista de pessoas ou equipas num projecto., A lista filtra à medida que escreve, por isso, logo que encontre o nome da pessoa ou equipa que está à procura, poderá usar as teclas de cursores para a seleccionar e carregar em tab ou enter para completar o nome. Para as equipes, insira a @organização / Equipe-nome e todos os membros dessa equipe serão subscritos à conversa.

os resultados autocompletos são restritos aos colaboradores do repositório e a quaisquer outros participantes no tópico.

Referenciando questões e puxando pedidos

você pode trazer uma lista de questões sugeridas e puxar pedidos dentro do repositório, digitando #., Digite a edição ou puxe o número do pedido ou o título para filtrar a lista, e depois carregue em tab ou enter para completar o resultado seleccionado.

para mais informações, consulte ” Referências autenticadas e URLs.”

Referenciando recursos externos

Se as referências personalizadas do autolink são configuradas para um repositório, então as referências a recursos externos, como uma emissão JIRA ou um ticket Zendesk, convertem-se em links abreviados. Para saber que autolinks estão disponíveis no seu repositório, contacte alguém com permissões de administração para o repositório., Para mais informações, veja ” Configurar autolinks para referência de recursos externos.”

anexos de conteúdo

algumas aplicações GitHub fornecem informações no GitHub para URLs que ligam para seus domínios registrados. O GitHub torna as informações fornecidas pelo aplicativo sob a URL no corpo ou comentário de um problema ou pedido de puxar.

para ver anexos de conteúdo, deverá ter uma aplicação GitHub que use a API de anexos de conteúdo instalada no repositório., Para mais informações, consulte “Instalar um aplicativo em sua conta pessoal” e “instalar um aplicativo em sua organização.”os anexos de conteúdo

não serão apresentados para os URLs que fazem parte de uma ligação de redução.

para mais informações sobre a construção de uma aplicação GitHub que usa anexos de conteúdo, veja “usando anexos de conteúdo.”

usando emoji

pode adicionar emoji à sua escrita escrevendo :EMOJICODE:.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

Digitando : vai abrir uma lista de sugestões de emoji., A lista irá filtrar à medida que escreve, logo que encontre o emoji que procura, carregue na página ou indique para completar o resultado seleccionado.

para uma lista completa de emoji e códigos disponíveis, Verifique a ‘Cheat-Sheet’ de Emoji.

parágrafos

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

a ignorar a formatação de Markdown

pode dizer ao GitHub para ignorar (ou escapar) a formatação de Markdown usando o antes do carácter de Markdown.,

Let's rename \*our-new-project\* to \*our-old-project\*.

“

Leitura Adicional

  • Github Markdown Spec
  • “sobre escrita e formatação no GitHub”

    • “trabalhar com formatação avançada”

  • “masterização”