Как создать текстовое поле для заметки в уценке?

Ответ 1

То, что я обычно делаю для размещения окна предупреждения (например, "Примечание" или "Предупреждение") в текстах уценки (не только при использовании pandoc, но и везде, где поддерживается эта уценка), окружает содержимое двумя горизонтальными линиями:

---
**NOTE**

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

---

что будет примерно так:

НОТА

Он работает со всеми разновидностями уценки (имеет значение пустая строка ниже).

Хорошо, что вам не нужно беспокоиться о том, какой аромат уценки поддерживается или какое расширение установлено или включено.

РЕДАКТИРОВАТЬ: Как @filups21 упомянул в комментариях, кажется, что горизонтальная линия представлена *** в RMarkdown. Таким образом, решение, упомянутое ранее, не работает со всеми ароматами уценки, как было заявлено изначально.

Ответ 2

Самое простое решение, которое я нашел для той же самой проблемы, - использовать таблицу с несколькими строками с одной строкой и без заголовка (в первом столбце и в тексте есть изображение):

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

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

Другим подходом, который может работать (для PDF), является использование директивы fbox по умолчанию Latex:

 \fbox{My text!}

Или модуль FancyBox для более продвинутых функций (и более перспективных): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox.

Ответ 3

С GitHub я обычно вставляю цитату.

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

становится...

ПРИМЕЧАНИЕ: содержание заметки.

Конечно, всегда есть простой HTML...

Ответ 4

Используйте расширение admonition. Для mkdocs его можно настроить в файле mkdocs.yml:

markdown_extensions:
    - admonition

Затем вставьте заметку в свои файлы md следующим образом:

!!! note

     This is a note.

См. пример здесь.

Ответ 5

Вот простой пример на основе латекса.

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

что приводит к:

К сожалению, поскольку это латекс, вы больше не можете включать уценку внутри поля TODO (что обычно не является большой проблемой), и оно не будет работать при преобразовании в форматы, отличные от PDF (например, html).

Ответ 6

Вы также можете использовать https://www.npmjs.com/package/markdown-it-container

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

Будет отображаться как:

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

Ответ 7

Вы пробовали использовать двойные вкладки? Чтобы сделать коробку:

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

Это работает для меня в обычном документе Rmarkdown с выводом html. Часть с двумя вкладками должна появиться в закругленной прямоугольной светло-серой рамке.