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


当前回答

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

markdown_extensions:
    - admonition

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

!!! note

     This is a note.

这里有一个例子。

其他回答

一行

> hello
> world

你好 世界

多线

方法

> hello
> 
> world (new line)

你好 世界(新线)

方法b

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

回声你好 呼应世界

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

----------------------- ------------------------------------
![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。

以下方法工作在GitHub,在GitLab…在Stackoverflow上,现在使用CommonMark!

>用Blockquote制作的一行盒子

用Blockquote制作的单行盒子

“用反划线制作的单行框”

单行盒与反刻度

' ' ' 盒子与三反tick ' ' '

Box made with Triple Backticks  

~ ~ ~ 用三个波浪线制作的盒子(删除波浪线之间的空间以使其工作) ~ ~ ~

Box made with Triple Tildes

每行开头有四个空格的方框:

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

... 还是用水平线?

三个破折号(——)组成一条水平线:


注意:“你的专注决定了你的现实。——奎刚·金。


对于更多的配置,我强烈推荐优秀的GitLab Markdown指南。 你也可以检查不太详细的GitHub基本格式语法。 您可以使用Babelmark比较Markdown实现。

有用提示:

要强制换行,在行尾放置两个空格; 要转义特殊字符,使用\。

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

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

然后渲染为:

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

使用GitHub,我通常会插入一个blockquote。

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

变得……

注:说明内容。

当然,总有简单的HTML…