DialetosSabores

Variações de Markdown com sintaxe diferente são chamadas de “sabores”. Os sabores de redução estão listados em https://github.com/jgm/CommonMark/wiki/Markdown-Flavors.

Um sabor Markdown pode ser implementado em várias linguagens de programação e aplicativos de software. As bibliotecas que implementam um analisador Markdown estão listadas em https://github.com/markdown/markdown.github.com/wiki/Implementations e https://www.w3.org/community/markdown/wiki/MarkdownImplementations.

Vários sabores de Markdown e as diferenças entre eles estão documentados em http://flavoredmarkdown.com.

Para testar e comparar o código Markdown em muitos sabores diferentes e implementações desses sabores, você pode usar a ferramenta online Babelmark.

Marcação de estouro de pilha #

Esse é o tipo de markdown usado pelo Stack Overflow e outros sites do Stack Exchange. Ao responder a uma pergunta ou adicionar documentação, você usa esse markdown. Esta resposta é feita de remarcação SO

Veja Documentação Oficial

As principais coisas que o SO markdown adiciona estão em “Adições do Stack Exchange” nessa página da Web. Em particular, SO adiciona tags como [tag:tag] e links de atalho como [meta] (mas não em documentos), spoilers:

! Isso é um spoiler

>! This is a spoiler

e devocionais de idioma personalizados

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Remarcação de Doxygen #

Doxygen é uma ferramenta de documentação de código comumente usada (para linguagens como C++, C# e Java) que também suporta o uso de Markdown. Além da sintaxe padrão do Markdown, há vários elementos específicos do Doxygen.

Os principais recursos são o uso de tags @ref para referências e os elementos @page, @section/@subsection e @anchor que podem referenciar.

@ref <nome> [“texto”] #

Este elemento cria um link (ou seja, referência) para uma seção, subseção, página ou âncora nomeada que foi definida em outro lugar na documentação. (consulte referência do Doxygen)

O primeiro parâmetro (name) deve corresponder ao nome da seção, subseção, página ou âncora que você deseja vincular.

O segundo parâmetro opcional (“texto”`) deve ser encapsulado entre aspas duplas e definirá como o link de referência aparecerá na página. Se não for usado, o link aparecerá como o título usado na referência.

@section <nome-da-seção> (título da seção) #

Este elemento define um nome de seção. É visualmente equivalente a um elemento # no Markdown, mas também definirá uma referência que pode ser vinculada a outras seções de sua documentação. (consulte referência do Doxygen)

O primeiro parâmetro section-name define o nome de referência que pode ser usado pelo elemento @ref. Isso não pode conter espaços.

O segundo parâmetro título da seção é uma sequência de palavras (que pode ser separada por espaços) que define como o cabeçalho da seção aparecerá em sua página.

Exemplo #

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Resultado #

Introdução #

Este é um texto na minha introdução.

Corpo do Parágrafo #

Este é algum texto no meu corpo, onde me refiro à Introdução.

NB: A palavra Introdução acima aparecerá como um link que pulará para o cabeçalho Introdução.

Markdown com sabor do GitHub #

GitHub Flavored Markdown (às vezes abreviado para GFM) facilita o trabalho com markdown em GitHub.com.

Os principais recursos do GFM incluem:

• recuo do código
• suporte a lista de tarefas
• referência fácil de problemas do GitHub
• nome de usuário GitHub automático e detecção de SHA
• detecção automática de URL
• suporte para emojis

exemplos de GFM #

Realce de sintaxe #

Com Markdown, um bloco de código pode ser gerado com três backticks:

```

Sem realce de sintaxe, o código escrito em C aparece assim

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

No entanto, com destaque de sintaxe, o código escrito em C aparece assim:

Para realçar o código, basta adicionar um identificador de idioma opcional para habilitar o realce de sintaxe em seu bloco de código protegido.

```C
<texto de código aqui>
```

Esses aprimoramentos são projetados para melhorar a qualidade da documentação e da conversa incluída nos arquivos README, gists, pull requests e issues na plataforma.