我正在用markdown写文档。我正在使用神奇的pandoc从markdown源创建docx和tex文件。我想有一个文本框提示和注释的读者编程书籍经常做的方式。我不知道如何做到这一点在markdown。你能帮忙吗?
当前回答
这是一个简单的基于乳胶的例子。
---
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
结果是:
不幸的是,因为这是latex,所以你不能再在TODO框中包含markdown(通常这不是一个大问题),并且当转换为PDF以外的格式(例如html)时,它将不起作用。
其他回答
你也可以使用https://www.npmjs.com/package/markdown-it-container
::: warning
*here be dragons*
:::
然后渲染为:
<div class="warning">
<em>here be dragons</em>
</div>
以下方法工作在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实现。
有用提示:
要强制换行,在行尾放置两个空格; 要转义特殊字符,使用\。
另一个解决方案是使用CSS邻接并使用h4(或更高):
#### note
This is the note content
h4 {
display: none; /* hide */
}
h4 + p {
/* style the note however you want */
}
使用警告扩展。对于mkdocs,可以在mkdocs中配置。yml文件:
markdown_extensions:
- admonition
然后在md文件中插入注释,如下所示:
!!! note
This is a note.
这里有一个例子。
使用GitHub,我通常会插入一个blockquote。
> **_NOTE:_** The note content.
变得……
注:说明内容。
当然,总有简单的HTML…
推荐文章
- 差异语法突出显示在Github Markdown
- 我如何创建一个文本框的笔记在markdown?
- 在Markdown中创建一个没有标题的表
- R -降价避免包装加载消息
- 在MarkDown中包含SVG(托管在GitHub上)
- 自动TOC在github风味markdown
- 使用pandoc从Markdown转换为PDF时设置空白大小
- 如何显示数学方程在一般github的markdown(不是github的博客)
- 使用Markdown的Sphinx而不是reST
- 降价和图像对齐
- 如何样式一个JSON块在Github维基?
- 标记“本机”文本对齐方式
- Markdown和包括多个文件
- 降价vs加价——它们有关联吗?
- 如何在降价表中编写列表?