Guia básico de markdown

Aprenda a usar o markdown para criação de instruções com alto grau de compreensão pelas IAs.

Markdown Syntax é uma sintaxe usada para padronizar e facilitar formatação de texto na web. Textos estilizados com Markdown são, na maioria dos casos, apenas texto com caracteres não-alfabéticos, como #, \* e ![](), usados para a configuração de títulos, listas, itálico, negrito e inserção de imagens.

O Markdown funciona como um conversor de texto para HTML: os caracteres não-alfabéticos são traduzidos como <b>, <i> e <a href>, etc. Já os textos sem formatação entram como parágrafo simples <p>.

Lista de comandos em Markdown

Veja abaixo uma lista dos comandos em markdown e alguns exemplos de seu uso:

Titulação

# Título <h1>
## Título <h2>
### Título <h3>
#### Título <h4>
##### Título <h5>
###### Título <h6>

Exemplos de titulação

Título 1

Título 2

Título 3

Título 4

Título 5

Título 6

Ênfase

Para adicionar ênfase ao conteúdo que será escrito, usa-se o asterisco * ou traço-baixo (underline) _:

  • Negrito: adicione dois asteriscos **texto** ou dois traços-baixos __texto__ no início e no fim do conteúdo.

  • Itálico: adicione apenas um asterisco *texto* ou um traço-baixo _texto_ no início e no fim do conteúdo.

Este é um exemplo de um texto que possui uma ênfase em **negrito**, e outro em _itálico_.

Existem duas formas de inserir link em Markdown, através de um link direto ou usando um texto-âncora:

  • Texto-âncora: utilize os caracteres [](), adicionando entre chaves o texto que você quer que apareça, e entre os parênteses, o endereço de destino, no formato [exemplo](https://exemplo.com/).

  • Link direto: envolva o endereço da web em chaves <>. O endereço ficará visível e será clicável pelo usuário. O endereço em forma de link direto tem o formato <https://exemplo.com/>.

Este é um link em formato de texto, e este é um link direto https://www.deeliv.app.

Listas de itens

Para listas não ordenadas, utilize um asterisco * na frente to item da lista:

* Item 1
* Item 2
* Item 3

Para listas ordenadas, utilize o número do item seguido de ponto . :

1. Item 1
2. Item 2
3. Item 3

As listas acima serão exibidas dessa maneira, respectivamente:

  • Item 1

  • Item 2

  • Item 3

  1. Item 1

  2. Item 2

  3. Item 3

Imagens

O código para inserir uma imagem no conteúdo é semelhante ao código de inserir links-âncora, adicionando um ponto de exclamação ! no início do código, como no exemplo abaixo:

![Alt ou título da imagem](URL da imagem)

Esta é uma linha com uma imagem personalizada .

Imagens grandes podem estar em linhas individuais, para serem exibidas em maior tamanho.

Citação (Quote)

Para transformar um texto em uma citação ou comentário, semelhante ao código HTML <blockquote>, utilize o sinal > no início da linha que será formatada:

>Este é um *blockquote*. O sinal usado abre e fecha este código no HTML. 
>Para adicionar mais uma linha à citação, basta teclar Enter para um novo
>código sinal. Isso gerará um novo parágrafo dentro do *blockquote*.
>Códigos de **negrito**, _itálico_ e <https://www.deeliv.app> funcionam aqui.

Como aparece no HTML:

Este é um blockquote. O sinal usado abre e fecha este código no HTML. Para adicionar mais uma linha à citação, basta teclar Enter para um novo código sinal. Isso gerará um novo parágrafo dentro do blockquote. Códigos de negrito, itálico e https://links.com funcionam aqui.

Código (Code Highlight)

Há dois modos de adicionar trechos de código ao Markdown:

  • Código em linha (inline): adicione um acento grave ˋ no início e no final do código.

  • Múltiplas linhas de código: envolva as linhas de código com três acentos graves ˋˋˋ ou três tils ~~~.

 Esta é uma linha que contém um ˋcódigoˋ.

ˋˋˋ
Esta é uma linha de código
 ˋˋˋ

Para especificar que tipo de linguagem está sendo apresentada no bloco de códigos adicionando o nome da linguagem de programação após o ˋˋˋ ou ~~~, por exemplo ~~~javascript ou ~~~ruby. Veja nos exemplos abaixo:

~~~javascript
Esta é uma linha de código em Javascript.
~~~

~~~php
Esta é uma linha de código em PHP.
~~~

~~~html
Esta é uma linha de código em HTML.
~~~

JAVASCRIPTPHPHTML

Esta é uma linha de código em Javascript.

Aqui está a lista de linguagens suportadas pelo Pygments, usada em nosso Learning Center.

Tabela

Escolha os títulos das colunas e use | para delimitar as colunas. Depois, utilize hífen - na segunda linha para indicar que acima estão os títulos das colunas, usando novamente o | para delimitar colunas. Veja um exemplo abaixo:

Exemplo   | Valor do exemplo
--------- | ------
Exemplo 1 | R$ 10
Exemplo 2 | R$ 8
Exemplo 3 | R$ 7
Exemplo 4 | R$ 8

Como aparece no Learning Center:

Exemplo
Valor do exemplo

Exemplo 1

R$ 10

Exemplo 2

R$ 8

Exemplo 3

R$ 7

Exemplo 4

R$ 8

Para especificar o tipo de alinhamento que deseja ter nas tabelas, utilize : ao lado do campo horizontal de hífens ---, na segunda linha da sua tabela. Veja abaixo:

  • Alinhado a esquerda: usar : no lado esquerdo (alinhamento padrão);

  • Alinhado a direita: usar : no lado direito;

  • Centralizado: usar : dos dois lados.

Veja no exemplo:

Alinhado a esquerda | Centralizado | Alinhado a direita
:--------- | :------: | -------:
Valor | Valor | Valor
Alinhado a esquerda
Centralizado
Alinhado a direita

Valor

Valor

Valor


Em caso de dúvidas, entre em contato conosco! 😄

Site: www.deeliv.app E-mail: [email protected] Chat de suporte: chat.deeliv.app Telefone: (15) 3261-7778

Last updated

Was this helpful?