Cheatsheet de markdown do Github
A remarca padrão
Markdown é um padrão desenvolvido por John Gruber. O principal objetivo com o Markdown é tornar o arquivo possível para ler mesmo em texto puro. Se você quiser procurar em um editor somente de texto, você deve ter mais tempo lendo-o. Isso é muito útil para os usuários de Vim e similares. Observe e lembre -se de que este é um padrão para alterar os arquivos de texto. Não está substituindo HTML. Em vez disso, você o usa para criar html onde é útil. No caso do Github, eles formatarão o arquivo ReadMe no site. Contanto que você siga o padrão, você pode ter certeza de que ficará bem.
Como o GitHub adicionou apenas algumas extensões, você deve começar usando uma folha de truques e vá a partir daí. Aqui está uma lista dos mais comuns.
| Markdown | Extensões | Resultado |
| # (1 por nível) | Títulos | |
| * | Itálico | |
| ** | Audacioso | |
| > | Bloco de citação | |
| 1. (etc.) | Lista ordenada | |
| - | Lista não ordenada | |
| 'código' | Seu código | |
| “' | MD-EXT | Inicie e termine um bloco de código |
| - | Regra horizontal | |
| [Descrição] (https: // www.exemplo.com) | Um nome em quadrado e URL entre colchetes | |
| ![TEXTO ALT] (imagem.png) | O mesmo, link para uma imagem | |
| [1] | MD-EXT | Uma nota de rodapé |
As listas podem ser aninhadas recuando os itens que você deseja ter aninhados.
Outras extensões para a marcação regular, você tem as extensões de blocos de código acima. Eles nem sempre são suportados por serviços.
| Markdown | Extensões | Resultado |
| ### cabeçalho #custom-id | MD-EXT | Um título que você pode abordar por seu ID |
| Termo: Definição | MD-EXT | Uma lista de termos com definições |
| ~ Texto equivocado ~ | MD-EXT | TEXTO DO TRATO |
| - [x] tarefa de fazer | MD-EXT | Uma lista de tarefas que você pode marcar |
A tabela é muito simples, mas você precisa de várias linhas para mostrar: Tabela:
| Nome | Valor || ----------- | ---------- |
| Tapetes | 100 |
Extensões do GitHub.
O GitHub adicionou algumas extensões para simplificar lidar com links para outras pessoas e projetos. Algumas delas são as tabelas mencionadas anteriormente. O que mais o ajudará é a extensão de reancho automática. Ele cria um link por conta própria quando você o usa no github.
Outros são tabelas e itens da lista de tarefas. Isso é conveniente para acompanhar suas tarefas em projetos. O último a mencionar é a extensão HTML bruta proibida. Com a ajuda desta extensão, algumas tags são filtradas ao renderizar para HTML. Essas tags podem causar efeitos estranhos ao renderizar ao github.
Maneiras de explorar o Markdown do Github
Se você achar confuso, também pode ir à página do Github e usar o editor embutido. Quando você o usar, ele completará algumas funções automaticamente. Isso funciona apenas para problemas, mas você pode usá -lo para descobrir algumas coisas, os emojis saem como uma lista quando você digita um cólon (:).
Você também pode encontrar um projeto no GitHub que tenha um ótimo arquivo de leitura e clone -o para a sua unidade local. A partir daí, você pode explorar o arquivo usando qualquer editor que desejar. Para os grandes editores, Emacs e Vim, há suporte para markdown por meio de extensões.
Se você estiver usando o VIM, pode colocar uma extensão de destaque da sintaxe do GitHub, Vim-Markdown. Esta extensão mostra que você fez o código corretamente. Para ajudá -lo a ver como fica quando é feito, você também pode obter a extensão do Live Mark. Com isso, você pode ter um servidor da web em execução, mostrando o resultado ao vivo enquanto digita.
Com o Emacs, você tem modo impaciente, moda ao vivo e pré-visualização em tempo real. Todos eles mostram sua página resultante em um navegador enquanto você digita. O primeiro requer menos bibliotecas que o último, mas precisa de um snippet de código extra para executar.
Conclusão
Embora o Markdown seja uma especificação pequena e deliberadamente simples, pode ser um pouco confuso começar com. A melhor maneira de aprender é usar uma folha de dicas e escrever seu documento de marcação. Você pode atualizar seu ReadMe.md no github, e você pode obter muito apoio das funções internas de seus editores. Como nota lateral, o Github também suporta emojis que você pode adicionar ao seu documento. Você pode usar a folha de dicas para descobrir quais são eles.
Faça o download do Markdown-Cheatsheethere