Mastering Markdown (Português)

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

o Que você vai aprender:

  • Como o formato Markdown faz o estilo de edição colaborativa fácil
  • Como Markdown difere do tradicional formatação abordagens
  • Como usar Markdown para formatar texto
  • Como utilizar o GitHub automática do Markdown renderização
  • Como aplicar GitHub exclusivo do Markdown extensões

o Que é Markdown?

Markdown é uma forma de estilo de texto na web., Você controla a exibição do documento; as palavras de formatação como negrito ou itálico, adicionando imagens e criando listas são apenas algumas das coisas que podemos fazer com o Markdown. Na maioria das vezes, o Markdown é apenas um texto regular com alguns caracteres não-alfabéticos lançados, como # ou*.,

Você pode usar Markdown a maioria dos lugares ao redor do GitHub:

  • Gists
  • Comentários em Problemas e Puxe Pedidos
  • Arquivos com o .md ou .markdown extensão

Para mais informações, consulte “Escrever no GitHub” no GitHub Ajuda.

Exemplos

  • Texto
  • Lista
  • Imagens
  • Cabeçalhos & Citações
  • Código
  • Extras

Sintaxe guia

Aqui está uma visão geral da sintaxe do Markdown que você pode usar em qualquer lugar GitHub.com ou em seus próprios arquivos de texto.,3>Headers

# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag

Emphasis

*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_

Lists

Unordered

* Item 1* Item 2 * Item 2a * Item 2b

Ordered

1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b

Images

!(/images/logo.png)Format: !(url)

Links

http://github.com - automatic!(http://github.com)

Blockquotes

As Kanye West said:> We're living the future so> the present is our past.

Inline code

I think you should use an`<addr>` element here instead.

GitHub Flavored Markdown

GitHub.,com usa sua própria versão da sintaxe do Markdown, que fornece um conjunto adicional de recursos úteis, muitos dos quais tornam mais fácil trabalhar com o conteúdo do GitHub.com.

Observe que alguns recursos do GitHub com Sabor Markdown só estão disponíveis nas descrições e observações dos Problemas e Pull requests. Estes incluem @mentions, bem como referências a hashes SHA-1, Questões e pedidos de puxão. Listas de tarefas também estão disponíveis em comentários Gist e em arquivos de marcação Gist.,

realce de Sintaxe

Aqui está um exemplo de como você pode usar o realce de sintaxe com o GitHub com Sabor de Markdown:

```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```

Você também pode simplesmente travessão seu código por quatro espaços:

 function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }

Aqui está um exemplo de código Python sem realce de sintaxe:

def foo(): if not bar: return True

Lista de Tarefas

Se você incluir uma lista de tarefas no primeiro comentário de um Problema, você terá um prático indicador de progresso no seu problema da lista. Também funciona em pedidos puxados!,pa rating cada coluna com um tubo de |:

se tornaria:

Cabeçalho da Primeira Segundo Cabeçalho
Conteúdo da célula 1 Conteúdo da célula 2
Conteúdo da primeira coluna Conteúdo da segunda coluna

SHA referências

Qualquer referência a uma consolidação do hash SHA-1 será automaticamente convertido em um link para que cometemos no GitHub.,

16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

Problema referências dentro de um repositório

Qualquer número que se refere a um Problema ou Solicitação será automaticamente convertido em um link.

#1mojombo#1mojombo/github-flavored-markdown#1

Username @menções

a Escrever um @ símbolo, seguido por um nome de usuário, irá notificar a pessoa para vir e ver o comentário. Isto é chamado de ” menção@”, porque você está mencionando o indivíduo. Você também pode @mencionar equipes dentro de uma organização.,

ligação automática para URLs

qualquer URL (como ) será automaticamente convertido em uma ligação clicável.

Strikethrough

qualquer palavra embrulhada com dois tildes (como ~~this~~) aparecerá riscada.

Emoji

GitHub suporta emoji!

para ver uma lista de todas as imagens que apoiamos, verifique a folha de batota do Emoji.

última atualização: 15 de Janeiro de 2014

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *

Ir para a barra de ferramentas