Skip to content

Instantly share code, notes, and snippets.

@alessandrofalls
Created November 22, 2024 20:09
Show Gist options
  • Save alessandrofalls/0c5a0eabf4961ca92dc9d61ffdb38072 to your computer and use it in GitHub Desktop.
Save alessandrofalls/0c5a0eabf4961ca92dc9d61ffdb38072 to your computer and use it in GitHub Desktop.
Aprendendo Markdown

A finalidade desta unidade é dar uma ideia do que é o Markdown. Para uma análise mais detalhada, consulte os artigos "Descrição da sintaxe do Markdown" e "Especificação do Markdown com um sabor de GitHub" na seção Resumo no final desse módulo.

Enfatizar texto

Para usar itálico no texto, basta colocar o texto de destino entre asteriscos (*) ou sublinhados (_).

This is *italic* text.
This is also _italic_ text.

Crie texto em negrito usando dois asteriscos (**) ou dois sublinhados (__).

This is **bold** text.
This is also __bold__ text.

Você também pode misturar tipos de ênfase diferentes.

_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
__This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.

Para usar um asterisco literal, preceda-o com um caractere de escape, que no GFM é uma barra invertida (\).

\_This is all \*\*plain\*\* text\_.

Declarar títulos

O HTML fornece títulos de conteúdo, como a tag <h1>. Em Markdown, isso tem suporte por meio do símbolo #. Basta usar um # para cada nível de título de 1 a 6.

###### This is H6 text

Criar links para imagens e sites

![octopus gitHub](images/github.png)

octopus gitHub

[Link to Microsoft Training](https://learn.microsoft.com/pt-br/training)

Link to Microsoft Training

Criar listas

Você pode definir listas ordenadas ou não ordenadas. Você também pode definir itens aninhados por meio de recuos.

  • As listas ordenadas começam com números.
  • As listas não ordenadas podem usar asteriscos ou traços (-).
  1. first
  2. second
  3. Third
  • First
    • nested
  • Second
  • Third

Criar tabelas

Você pode construir tabelas usando uma combinação de barras verticais (|) para quebras de coluna e traços (-) para designar a linha anterior como um cabeçalho.

First|Second
-|-
1|2
3|4
First Second
1 2
3 4

Texto da citação

Você pode criar blockquotes usando o caractere maior que (>).

> This is quoted text.

This is quoted text.

Two

Três

Quatro

Preencher as lacunas com HTML incorporado

Se você se deparar com uma situação de HTML que não é compatível com o Markdown, você pode usar o HTML incorporado.

Here is a<br />line break

Esta é uma
quebra de linha

Trabalhe com código

var first = 1;
var second = 2;
var sum = first + second;

Problemas de referência cruzada e solicitações de pull

O GFM é compatível com o uso de uma variedade de formatos de código curto para facilitar a criação de links para problemas e solicitações de pull. A maneira mais fácil de fazer isso é usar o formato #ID, como #3602 ![[links_github.png]]

Links para commits específicos

Você pode criar um link para um commit colando a respectiva ID ou, simplesmente, usando o respectivo algoritmo de hash seguro (SHA). ![[links_commits.png]]

Mencionar usuários e equipes

Digitar um símbolo @ seguido de um nome de usuário do GitHub enviará a essa pessoa uma notificação relativa ao comentário. Isso é chamado de uma "@menção", porque você está mencionando o indivíduo. Você também pode usar @mention com equipes dentro de uma organização.

Monitorar listas de tarefas

Você pode criar listas de tarefas dentro de problemas ou solicitações de pull usando a sintaxe abaixo. Isso pode ser útil para acompanhar o progresso quando usado no corpo de um problema ou solicitação de pull.

- [x] First task
- [x] Second task
- [ ] Third task
  • First task
  • Second task
  • Third task

Comandos de barra "/"

Os comandos de barra "/" podem economizar tempo reduzindo a digitação necessária para criar um Markdown complexo.

Use comandos de barra "/" em qualquer campo de descrição ou de comentário em problemas, solicitações de pull ou discussões em que há suporte para o comando de barra "/". ![[barra_markdown.png]]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment