我正在用markdown写文档。我正在使用神奇的pandoc从markdown源创建docx和tex文件。我想有一个文本框提示和注释的读者编程书籍经常做的方式。我不知道如何做到这一点在markdown。你能帮忙吗?


当前回答

我通常在标记文本中放置警告框(例如,注意或警告)(不仅在使用pandoc时,而且在任何支持标记的地方)是用两条水平线围绕内容:

---
**NOTE**

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

---

大概是这样的:


NOTE

它适用于所有降价的口味(下面的空白行很重要)。


好消息是你不需要担心哪个降价风味是支持的,或者安装或启用了哪个扩展。

编辑:正如@filups21在评论中提到的,在RMarkdown中,一条水平线似乎是由***表示的。所以,之前提到的解决方案并不像最初声称的那样适用于所有廉价口味。

其他回答

使用警告扩展。对于mkdocs,可以在mkdocs中配置。yml文件:

markdown_extensions:
    - admonition

然后在md文件中插入注释,如下所示:

!!! note

     This is a note.

这里有一个例子。

对于同样的问题,我发现的最简单的解决方案是使用一个多行表,只有一行,没有标题(第一列是图像,第二列是文本):

----------------------- ------------------------------------
![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)的方法是使用Latex默认的fbox指令:

 \fbox{My text!}

或FancyBox模块获得更高级的功能(和更好看的盒子):http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox。

截至2021年9月: 这里有一种方法建立一个文本框在markdown使用html div标签和类'warning'。它在Jupyter Notebook和Typora上工作得很好。 您可以修改背景和字体颜色。

<div class="warning" style='padding:0.1em; background-color:#E9D8FD; color:#69337A'>
<span>
<p style='margin-top:1em; text-align:center'>
<b>On the importance of sentence length</b></p>
<p style='margin-left:1em;'>
This sentence has five words. Here are five more words. Five-word sentences are fine. But several together bocome monotonous. Listen to what is happening. The writing is getting boring. The sound of it drones. It's like a stuck record. The ear demands some variety.<br><br>
    Now listen. I vary the sentence length, and I create music. Music. The writing sings. It has a pleasent rhythm, a lilt, a harmony. I use short sentences. And I use sentences of medium length. And sometimes when I am certain the reader is rested, I will engage him with a sentence of considerable length, a sentence that burns with energy and builds with all the impetus of a crescendo, the roll of the drums, the crash of the cymbals -- sounds that say listen to this, it is important.
</p>
<p style='margin-bottom:1em; margin-right:1em; text-align:right; font-family:Georgia'> <b>- Gary Provost</b> <i>(100 Ways to Improve Your Writing, 1985)</i>
</p></span>
</div>

或者(在设计上增加一点——圆角和边框)

<div class="warning" style='background-color:#E9D8FD; color: #69337A; border-left: solid #805AD5 4px; border-radius: 4px; padding:0.7em;'>
<span>
<p style='margin-top:1em; text-align:center'>
<b>On the importance of sentence length</b></p>
<p style='margin-left:1em;'>
This sentence has five words. Here are five more words. Five-word sentences are fine. But several together bocome monotonous. Listen to what is happening. The writing is getting boring. The sound of it drones. It's like a stuck record. The ear demands some variety.<br><br>
    Now listen. I vary the sentence length, and I create music. Music. The writing sings. It has a pleasent rhythm, a lilt, a harmony. I use short sentences. And I use sentences of medium length. And sometimes when I am certain the reader is rested, I will engage him with a sentence of considerable length, a sentence that burns with energy and builds with all the impetus of a crescendo, the roll of the drums, the crash of the cymbals -- sounds that say listen to this, it is important.
</p>
<p style='margin-bottom:1em; margin-right:1em; text-align:right; font-family:Georgia'> <b>- Gary Provost</b> <i>(100 Ways to Improve Your Writing, 1985)</i>
</p></span>
</div>

你也可以使用https://www.npmjs.com/package/markdown-it-container

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

然后渲染为:

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

一行

> hello
> world

你好 世界

多线

方法

> hello
> 
> world (new line)

你好 世界(新线)

方法b

> ```shell
> echo hello
> echo world
> ```

回声你好 呼应世界