Como posso criar uma caixa de texto para uma nota em markdown?

Estou a escrever um documento em markdown. Estou usando o maravilhoso pandoc para criar arquivos docx e tex a partir da fonte markdown. Eu gostaria de ter uma caixa de texto para dicas e notas para os leitores a forma como os livros de programação muitas vezes fazem. Não consigo descobrir como fazer isto em markdown. Podes ajudar?

Author: TJB, 2014-09-04
Source

6 answers

O que costumo fazer para colocar a caixa de alerta (por exemplo, nota ou aviso) nos textos de marcação (não só ao usar o pandoc, mas também em todos os locais onde essa marcação é suportada) está em torno do conteúdo com duas linhas horizontais: 

---
**NOTE**

It works with almost all markdown flavours (the below blank line matters).

---
O que seria algo parecido com isto:

Nota

Funciona com todos os sabores de marcação (a linha em branco abaixo importa).

O bom é que não precisas de te preocupar com qual sabor é suportado ou qual a extensão que está instalada ou activada.
 20
Author: cartoonist, 2017-01-03 18:10:04

A solução mais simples que encontrei para o mesmo problema é usar uma tabela de linhas múltiplas com uma linha e sem cabeçalho (há uma imagem na primeira coluna e o texto na Segunda): 

----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
                        bla bla bla bla bla bla bla ... the
                        blank line below is important 

----------------------------------------------------------------

Outra abordagem que pode funcionar (para PDF) é usar o Latex default fbox directiva: 

 \fbox{My text!}

Ou módulo FancyBox para funcionalidades mais avançadas (e caixas mais bonitas): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox.

 9
Author: Etienne Savard, 2014-09-09 17:11:24

Usa a admonição extensão. Para mkdocs , pode ser configurado no ficheiro mkdocs.yml: 

markdown_extensions:
    - admonition

Depois insira a nota nos seus ficheiros md do seguinte modo: 

!!! note

     This is a note.

Veja um exemplo aqui.

 6
Author: Boni García, 2016-03-15 14:58:37

Com o GitHub, costumo inserir um bloco

nota: o conteúdo da nota.

Claro que há sempre HTML simples...

 4
Author: Vlad, 2017-03-30 14:29:59
Aqui está um exemplo simples baseado em latex. 
---
header-includes:
    - \usepackage[most]{tcolorbox}
    - \definecolor{light-yellow}{rgb}{1, 0.95, 0.7}
    - \newtcolorbox{myquote}{colback=light-yellow,grow to right by=-10mm,grow to left by=-10mm, boxrule=0pt,boxsep=0pt,breakable}
    - \newcommand{\todo}[1]{\begin{myquote} \textbf{TODO:} \emph{#1} \end{myquote}}
---

blah blah

\todo{something}

blah

O que resulta em: enter image description here

Infelizmente porque este é o latex, você não pode mais incluir o markdown dentro da caixa de TODO (o que não é um grande problema, geralmente), e ele não vai funcionar ao converter para outros formatos que não o PDF (por exemplo, html).

 1
Author: naught101, 2018-01-25 04:38:48

Também pode utilizar https://www.npmjs.com/package/markdown-it-container

::: warning
*here be dragons*
:::

Irá então renderizar como: 

<div class="warning">
<em>here be dragons</em>
</div>
 0
Author: Alinex, 2017-03-15 06:12:16