Ao mesmo tempo, o Markdown é muito leve e flexível também. O caso de uso mais popular para Markdown é para arquivos de licença e leitura em um repositório do GitHub, mas também está sendo integrado a cada vez mais CMS para gerenciar postagens de blog e até escrever trabalhos de pesquisa. Você pode renderizar equações matemáticas com plugins para látex.
É usado principalmente pelos desenvolvedores, no entanto. É realmente útil para fazer tutoriais e documentação graças ao destaque da sintaxe para vários idiomas e suporte para imagens e até GIFs.
Vamos começar com uma configuração que nos permite visualizar o documento renderizado ao lado de um arquivo de texto em marcação bruta.
Editor de texto Atom e visualização de marcha
Você pode baixar e instalar o editor de texto Atom ou o código do Visual Studio para acompanhar. Código Atom e VS possuem plugins pré-instalados para visualização de marcação. Aqui o Atom será usado, mas a sintaxe permaneceria aproximadamente a mesma, independentemente do editor de texto que você usa.
No Atom, verifique se o pacote de visualização do Markdown está ativado (é, de fato, ativado por padrão). Crie uma pasta para este tutorial de Markdown e, lá, abra um novo arquivo (Ctrl + N) e digite o seguinte texto lá.
# Este é um títuloSalve o arquivo (CRTL + s) com um .Extensão do MD. Por exemplo, você pode nomear seu arquivo como teste.md e o .A parte do MD dirá ao Atom que este é um arquivo de remarca e a extensão funcionaria com ele como pretendido. Você pode gerar uma visualização usando o seguinte Keybinding (Ctrl+Shift+M), que é mostrado em um novo painel ao lado do arquivo de texto bruto.
Você pode fechar o painel de visualização usando a mesma ligação à chave ou usando a própria GUI.
Com tudo configurado, podemos dar uma olhada mais de perto na sintaxe e começar a criar documentos incríveis em tempo real.
Sintaxe de Markdown
Como mencionado anteriormente, a principal motivação por trás do Markdown é a legibilidade. Isso significa que não há tags obscuras ou tags aninhadas ou qualquer outra confusão indutora de confusão. Em vez disso, podemos começar com o símbolo '#' para indicar que essa linha específica é um título.
# É um título.Markdown continua a agrupar todo o texto em um parágrafo gigante, mesmo quando o texto bruto é dividido em várias linhas diferentes. Para mitigar isso, você pode usar dois espaços no final de uma linha e depois colocar um personagem de nova linha (ou seja, acertar ) ou apenas use dois caracteres de nova linha para um efeito ligeiramente diferente, como mostrado abaixo.
A frase "é por isso que ..." começou em uma nova linha, mas não é espaçada à parte da linha anterior, enquanto que o uso de duas novas linhas criou uma separação mais ampla.
A regra horizontal, como o nome sugere, cria uma linha horizontal que permite estruturar seu documento e fazer separações lógicas nele. Existem dois métodos para criar uma regra horizontal. Primeiro é usar três ou mais sublinhados para criar uma regra horizontal.
#Cabeçallho 1Outra opção (que não recomendo) é usar três ou mais traços '-', mas eles também são usados para indicar que a frase imediatamente acima deles é um título. Portanto, se você não tiver uma nova linha entre uma frase e a regra horizontal abaixo dela, essa frase assumirá a forma de um título.
A sintaxe para os três é bastante simples e fala por si.
** Isso está em negrito **Agora, pode -se perguntar: como você literalmente escreveria ** algum texto ** no arquivo final de marcação se ele mudar isso para ousado sempre. Isso é algo com o qual a maioria das linguagens de programação também lida e a solução é semelhante àquelas - use um caractere de barra de barragem. Isso também funciona para outros elementos de sintaxe e não é especificamente para estilo em negrito.
\ ** isso não é mais ousado \ **BlockQuotes e blocos de código são muito mais fáceis. Um BlockQuote pode ser usado para destacar um ponto importante para o qual você deseja chamar a atenção dos leitores. Isso pode ser alcançado usando o suporte angular direito no início, como mostrado.
# Cabeçallho 1Veja como fica quando é renderizado.
Para blocos de código, simplesmente recue as linhas das linhas em 4 espaços ou mais. Isso é realmente
prático para desenvolvedores e operadores que desejam documentar seu trabalho. Mais tarde veríamos como tornar isso ainda melhor.
Para hiperlinks, a sintaxe é bem simples. O texto visível é escrito entre colchetes e o URL para o qual aponta é escrito em suportes redondos ao lado dele.
Para imagens, a sintaxe é semelhante, exceto que começa com uma marca de exclamação. Você é livre para usar um caminho relativo na pasta do projeto que aponte para a imagem ou você pode ter um URL público.
## ilustrando o hiperlink e a sintaxe da imagemCriar tabelas em Markdown inclui literalmente desenhar um retrato ASCII (Unicode para ser preciso).
## tabelasA sintaxe não precisa estar exatamente alinhada de uma linha para outra, mas o caractere do tubo é usado para mudar para a próxima coluna e a próxima linha indica que a próxima linha foi iniciada, geralmente.
Marcada estendida
Para aqueles de vocês que chegaram tão longe, aqui está o verdadeiro deleite. Se você estiver usando o Atom, poderá substituir o plug -in de visualização do Markdown para o Markdown Preview Plus. Que oferece as seguintes funcionalidades.
Você pode realmente inserir scripts de látex entre sinais de dólar e ele será renderizado como script de látex e mostrado na visualização com Ctrl+shitft+x Keybinding. Você nem precisa saber todo o látex, apenas alguns trechos são suficientes.
## ilustrando látexEm vez de usar o recuo para indicar blocos de código, você pode realmente usar backticks seguidos pelo nome dos idiomas em que seu script é supostamente escrito. Os idiomas cuja sintaxe são suportados são numerosos demais para listar aqui, mas aqui está um exemplo no Python.
## ilustrando o destaque da sintaxeExistem muitos sabores ou markdown. O GitHub tem sua própria bebida especial e a sintaxe é muito flexível. Isso não deve intimidar os usuários, mas atender a uma variedade mais ampla deles. É um daqueles idiomas que apenas se entende um subconjunto que se precisa e o usa, em vez de se incomodar com os detalhes técnicos (a menos que você esteja interessado em seus detalhes técnicos!)