Guia para iniciantes em Markdown: tudo o que você precisa saber para começar

Índice

• O que é Markdown?
  • Vantagens de usar Markdown
• Primeiros passos com Markdown
  • Formatação básica em Markdown
  • Formatação avançada em Markdown
• Aplicativos do mundo real em Markdown
• Recursos

A capacidade de apresentar seus pensamentos e ideias de forma clara e concisa é importante, independentemente do setor em que você trabalha. Felizmente, há uma série de ferramentas e tecnologias que ajudam a criar um bom conteúdo de texto.

Digite Markdown – uma linguagem de marcação versátil, mas despretensiosa, que se tornou um produto básico para escritores, programadores e criadores de conteúdo de todos os tipos.

Se você é novo no mundo do Markdown, não tema; este guia foi projetado para ser sua bússola em uma jornada para dominar essa linguagem de marcação amigável.

O que é redução?

Markdown é uma linguagem de marcação leve que simplifica o processo de formatação de texto para a web e outras mídias. Foi criado por John Gruber e Aaron Swartz em 2004 como uma forma de escrever conteúdo que pode ser facilmente convertido em HTML e outros formatos sem exigir amplo conhecimento técnico.

É particularmente popular entre escritores, blogueiros, programadores e qualquer pessoa que precise de uma maneira simples e eficiente de formatar texto para a web.

Vantagens de usar Markdown

1. Simplicidade e legibilidade: Markdown usa uma sintaxe simples usando caracteres de texto simples. Essa simplicidade facilita o aprendizado e o uso, permitindo que você se concentre no conteúdo em si, em vez de em códigos de formatação complexos.

2. Independência de plataforma: Markdown é independente de plataforma. Você pode criar documentos Markdown em qualquer dispositivo usando um editor de texto ou editor de código, e esses documentos podem ser facilmente visualizados e convertidos em vários formatos em diferentes plataformas. Essa consistência garante a acessibilidade e longevidade do seu conteúdo.

3. Curva de aprendizado rápido: Markdown tem uma das sintaxes mais fáceis. Isso significa que você pode aprender em um curto espaço de tempo. A sintaxe é intuitiva, semelhante à formatação que você já usa em e-mails ou mensagens de texto.

Essa rápida curva de aprendizado incentiva a adoção por aqueles que não são usuários técnicos.

4. Ampla adoção: Markdown ganhou imensa popularidade e é compatível com uma infinidade de plataformas, incluindo sistemas de blogs como WordPress, ferramentas de colaboração como GitHub e sistemas de gerenciamento de conteúdo. Isso torna o Markdown uma habilidade valiosa que pode ser aplicada em muitos contextos.

5. Velocidade e eficiência: Criar conteúdo no Markdown é rápido e eficiente. Com alguns caracteres simples e outros elementos de formatação. Isso, em troca, permite que seus usuários criem documentos com simplicidade, eficiência e rapidez.

6. Controle de versão: ao usar o Markdown em colaboração com sistemas de controle de versão como o Git, as alterações feitas nos arquivos Markdown são fáceis de rastrear. Isso torna mais simples colaborar em projetos, revisar alterações e manter um registro claro das edições.

Introdução ao Markdown

Markdown funciona em uma variedade de editores de texto e editores de código. Neste artigo, vamos nos concentrar no uso de markdown em editores de código, especialmente no VS Code . Porém, a mesma sintaxe pode ser seguida em editores de texto.

1. Primeiramente, em seu VS Code, crie uma pasta (você pode nomeá-la como quiser). Nessa pasta, crie um arquivo chamado markdown.md

   
   

2. Navegue até a seção superior direita do seu arquivo VS Code e clique no botão de visualização para obter uma visualização do resultado lado a lado.

   

Formatação básica em Markdown

Aqui estão algumas das sintaxes básicas para formatação de texto no Markdown.

1. Cabeçalhos : cabeçalhos são usados para indicar diferentes níveis de cabeçalho em seu documento. Para criar cabeçalhos no Markdown, use o símbolo # seguido de um espaço e depois do texto do cabeçalho. Observe que o número de símbolos # determina os níveis do seu título. Veja o exemplo abaixo.

    # Heading ## Heading ### Heading 

   

2. Ênfase: Você pode dar ênfase ao seu texto colocando-o em negrito ou itálico. Para deixar o texto em negrito, coloque-o entre asteriscos duplos ** ou sublinhados duplos __ . Para deixar o texto em itálico, coloque-o entre asteriscos únicos * ou sublinhados únicos _ .

Exemplo:

 This is the **Bold Text** This is *italics* 

3. Listas: Markdown oferece suporte a listas ordenadas (numeradas) e não ordenadas (com marcadores). Para criar uma lista ordenada, comece cada item com um número seguido de um ponto final. Para criar uma lista não ordenada, use um asterisco * , mais + ou hifens - .

Exemplo:

 Ordered List: 1. First item 2. Second item 3. Third item Unordered List: * Item 1 * Item 2 * Item 3 

4. Links: você pode criar hiperlinks no Markdown usando colchetes [] para o texto do link e parênteses () para o URL do link.

Exemplo:

 [Visit Odafe's Website](https://www.odafe.vercel.app)

5. Imagens: Inserir imagens é semelhante a criar links; a única diferença é um ponto de exclamação ! na frente dos colchetes. O texto alternativo entre colchetes é usado para descrever a imagem para acessibilidade.

Exemplo:

 ![Alt text](image-url.jpg)

6. Blockquotes : Blockquotes são usados para exibir textos de citações. Para criar isso basta iniciar a linha com o símbolo > seguido do texto que deseja citar.

Exemplo:

 > This is a quote by Odafe

A saída é semelhante a esta:

Esta é uma citação de Odafe

7. Regra horizontal : você pode adicionar separadores horizontais simplesmente usando três sublinhados _ .

Exemplo:

 This is a regular text ____ This is more regular text 

Estes são os elementos fundamentais da formatação básica no Markdown. Ao dominar esses conceitos, você será capaz de criar conteúdo bem estruturado e visualmente atraente, seja escrevendo uma nota simples ou elaborando um documento mais complexo.

Formatação avançada em Markdown

Markdown também oferece funcionalidade adicional nos casos em que você precisa adicionar elementos mais complexos ao seu documento. Algumas dessas opções de formatação são:

1. Blocos de código e código embutido : você pode facilmente adicionar blocos de código ao seu arquivo iniciando seus blocos de código com três crases (```) seguidos pelo idioma em que seu bloco de código está escrito. em crases únicos.

Exemplo:

 This is a HTML element `<div>Hello World</div>` ```javascript function myFunction() { console.log("Hello world!") } 

2. Listas de tarefas: As listas de tarefas são úteis para criar listas de tarefas. Para criar uma lista de tarefas, use colchetes com um “x” para tarefas concluídas e um espaço para tarefas incompletas.

Exemplo:

 - [x] A complete task - [ ] An incomplete task 

3. Emojis : Existem duas maneiras de adicionar emoji a arquivos Markdown: copie e cole o emoji em seu texto formatado em Markdown ou digite códigos de acesso de emoji .

4. Texto tachado: para tachado no texto, use tils duplos ( ~~ ) ao redor do texto que deseja tachado.

Exemplo:

 This is a ~~Strikethrough~~ text.

5. Caracteres de escape: Se precisar exibir caracteres com significado especial no Markdown, você pode escapá-los usando uma barra invertida ( \ ).

 To display a literal asterisk \* use a backslash before it.

6. Sobrescrito e Subscrito: Para criar um sobrescrito, o texto sobrescrito é envolvido por dois símbolos ^ .

Para criar texto subscrito, o texto é encapsulado em dois símbolos ~ .

Exemplos:

 This is how a superscript is written: X^2^ This is how a subscript is written: H~2~O. 

7. Tabelas : Para criar tabelas no Markdown, siga estas etapas:

• Comece e termine cada linha com um símbolo de barra vertical ( | ).
• Separe cada coluna com um símbolo de barra vertical ( | ).
• Use três ou mais hífens ( --- ) para criar cabeçalhos de coluna.

 | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |

Saída:

8. Destaque : você pode destacar palavras importantes em seu documento usando dois sinais de igual ( == ) antes e depois da(s) palavra(s).

Exemplo:

 This highlighted word is ==Bee==

Saída:

9. Notas de rodapé : As notas de rodapé são uma forma de adicionar notas e referências no final do documento sem sobrecarregar o corpo principal. Para criar uma referência de nota de rodapé, adicione um símbolo de circunflexo ( ^ ) e um identificador exclusivo (geralmente números ou palavras) entre colchetes ( [^1] ).

Os identificadores não podem conter espaços ou tabulações. Na saída, as notas de rodapé são numeradas sequencialmente.

Exemplo:

 This is an example sentence with a footnote[^1]. [^1]: This is the content of the footnote.

A saída:

Você pode aprender mais sobre formatação avançada no Markdown aqui.

Aplicativos do mundo real em Markdown

Markdown ganhou muita popularidade entre os desenvolvedores de software e a comunidade de programação. Notavelmente, encontrou um papel fundamental nas plataformas de controle de versão, servindo como um meio abrangente e acessível para explicar a essência de uma base de código.

Ao empregar Markdown como um canal para descrever as complexidades do código, os desenvolvedores criam uma mistura harmoniosa de clareza e contexto.

Essa prática ajuda aqueles que se deparam com seu repositório de código, facilitando uma compreensão rápida e profunda do propósito geral e das nuances do projeto.

Desta forma, o Markdown se destaca não apenas como uma ferramenta de formatação, mas também como um comunicador poderoso, preenchendo a lacuna entre os intrincados esforços de codificação e suas profundas implicações no mundo real.

Conclusão

Lembre-se de que o Markdown não é apenas uma ferramenta; é uma ponte que conecta seus pensamentos a um público global, permitindo que sua voz seja ouvida com clareza e impacto.

Sua compatibilidade com diversas plataformas, sua simplicidade e adaptabilidade garantem que sua jornada com o Markdown não se limite a este guia, mas continue à medida que você explora novas maneiras de se expressar e expressar suas ideias.

Recursos

• Folha de dicas: https://www.markdownguide.org/cheat-sheet/

• Tutorial: https://www.markdowntutorial.com/

• Tutorial: https://commonmark.org/help/tutorial/

  
  

Também publicado aqui