Como posso criar uma caixa de texto para uma nota na marcação?

Question 1

Estou escrevendo um documento em markdown. Estou usando o maravilhoso pandoc para criar arquivos docx e tex a partir da origem do markdown. Eu gostaria de ter uma caixa de texto para dicas e notas para os leitores, como costumam fazer os livros de programação. Não consigo descobrir como fazer isso no markdown. Você pode ajudar?

Question 2

O que eu normalmente faço para colocar a caixa de alerta (por exemplo, Nota ou Aviso) em textos de marcação (não apenas ao usar o pandoc, mas também em todos os lugares onde essa marcação é suportada) é circundar o conteúdo com duas linhas horizontais:

---
**NOTE**

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

---

que seria algo assim:

NOTA

Ele funciona com todos os tipos de markdown (a linha em branco abaixo é importante).

A boa notícia é que você não precisa se preocupar com qual tipo de markdown é compatível ou qual extensão está instalada ou habilitada.

EDIT : Como @ filups21 mencionou nos comentários, parece que uma linha horizontal é representada por ***no RMarkdown. Portanto, a solução mencionada antes não funciona com todos os tipos de markdown, como foi originalmente reivindicado.

Question 3

Com o GitHub, geralmente insiro um blockquote.

> **_NOTE:_**  The note content.

torna-se...

NOTA: O conteúdo da nota.

Claro, sempre há HTML simples ...

Question 4

A solução mais simples que encontrei para exatamente o mesmo problema é usar uma tabela de várias linhas com uma linha e nenhum 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 a diretiva fbox padrão do Latex :

 \fbox{My text!}

Ou o módulo FancyBox para recursos mais avançados (e caixas com melhor aparência): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox .

Question 5

Use a extensão de admoestação . Para mkdocs , ele pode ser configurado no mkdocs.ymlarquivo:

markdown_extensions:
    - admonition

Em seguida, insira a nota em seus arquivos md da seguinte maneira:

!!! note

     This is a note.

Veja um exemplo aqui .

Question 6

Semelhante à solução de Etienne, uma tabela simples formata bem:

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

Outra alternativa (que vem com mais ênfase) é fazer do conteúdo o cabeçalho de uma tabela sem corpo:

|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|
|-|-|

Finalmente, você pode incluir uma linha horizontal (quebra temática) para criar uma caixa fechada (embora o estilo da linha seja um pouco diferente da linha do cabeçalho na tabela):

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

---

Observe a linha vazia após o texto.

Question 7

Aqui está um exemplo simples baseado em látex.

---
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:

Infelizmente, por ser látex, você não pode mais incluir markdown dentro da caixa TODO (o que não é um grande problema, normalmente) e não funcionará ao converter para formatos diferentes de PDF (por exemplo, html).

Question 8

Os métodos a seguir funcionam no GitHub, no GitLab ... e no Stackoverflow , que agora usa CommonMark !

> Caixa One-Line feita com Blockquote

Caixa de uma linha feita com Blockquote

`Caixa One-Line feita com Backticks`

One-Line Box made with Backticks

`` `
Caixa feita com Backticks Triplos`
``

Box made with Triple Backticks

~ ~ ~
Caixa feita com Triplo Tils _{^{(remova os espaços entre os Tis para fazer este trabalho)}}
~ ~ ~

Box made with Triple Tildes

Caixa feita com quatro espaços no início de cada linha:

    “Sometimes we must let go of our pride and do what is requested of us.”
    Padmé Amidala

... ou usar linhas horizontais?

Três traços (---) formam uma linha horizontal:

Nota : “Seu foco determina sua realidade.” - Qui-Gon Jinn.

Para mais configurações, recomendo fortemente o excelente Guia de Markdown do GitLab .
Você também pode verificar a sintaxe de formatação básica do GitHub menos detalhada .
Você pode comparar as implementações do Markdown usando o Babelmark .

Dicas úteis:

para forçar uma nova linha, coloque dois espaços no final da linha;
para escapar de caracteres especiais, use \.

Question 9

Você já tentou usar guias duplas? Para fazer uma caixa:

Start on a fresh line
Hit tab twice, type up the content
Your content should appear in a box

Ele funciona para mim em um documento Rmarkdown regular com saída html. A parte com abas duplas deve aparecer em uma caixa retangular arredondada cinza claro.

Question 10

Você também pode usar https://www.npmjs.com/package/markdown-it-container

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

Será então renderizado como:

<div class="warning">
<em>here be dragons</em>
</div>