如何在降价中为备注创建文本框?

时间:2014-09-03 22:52:45

标签: markdown pandoc

我正在降价处写一份文件。我正在使用精彩的pandoc从markdown源创建docx和tex文件。我希望有一个文本框,可以为读者提供编程书籍常用的方法。我无法弄清楚如何在降价时这样做。你能帮忙吗?

11 个答案:

答案 0 :(得分:34)

我通常在降价文本中设置警告框(例如,注意或警告)(不仅在使用pandoc时,而且在每个支持降价的地方)都是用两条水平线围绕内容:

---
**NOTE**

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

---

这将是这样的:

注意

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

好消息是您不必担心支持哪种降价风格或安装或启用了哪种扩展名。

编辑:正如@ filups21在评论中提到的,似乎RMarkdown中的***表示水平线。因此,之前提到的解决方案不适用于最初声明的所有降价风格。

答案 1 :(得分:14)

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

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

...变为

  

注意: 注释内容。

当然,总是有简单的HTML ...

答案 2 :(得分:12)

我发现完全相同的问题的最简单的解决方案是使用多行表,其中一行没有标题(第一列中有图像,第二列中有文字):

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

答案 3 :(得分:7)

我通常插入一个 blockquote 并在其中添加一个 Unicode 字符(memo? 即(U+1F4DD))。

<块引用>

? ...

<头>
语法 演示
> ? bla bla ...

?bla bla ...

> ``?`` bla bla

? bla bla

> *?* bla bla

? bla bla


表情符号

当然,如果你不喜欢?,你可以搜索你喜欢的。相信一定会有一款让您满意!

  • 查找更多表情符号:https://emojipedia.org/

    只要搜索你喜欢的图标并复制粘贴就可以了(因为它是一个字符,所以它适用于所有设备)

  • find Code

    如果你不喜欢复制粘贴,想自己打字,可以考虑搜索Unicode。

    ![enter image description here


附言也可以关注emoji版本(一般和Unicode版本一样),以后可能会出现更多让你满意的图标。

答案 4 :(得分:6)

使用admonition扩展程序。对于mkdocs,可以在mkdocs.yml文件中配置:

markdown_extensions:
    - admonition

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

!!! note

     This is a note.

查看示例here

答案 5 :(得分:5)

以下方法可在GitHub,GitLab ...和on Stackoverflow(现在使用CommonMark)上运行!


>用Blockquote制成的单线盒

使用Blockquote制成的单线盒


“带有反引号的单行框”

One-Line Box made with Backticks


```
带三个反引号的盒子
```

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


...还是使用水平线?

三个破折号(---)划一条水平线:


注意:“您的注意力决定了您的现实。” – Qui-Gon Jinn。


有关更多配置,我强烈建议使用出色的GitLab Markdown Guide
您还可以检查不太详细的GitHub basic formatting syntax
您可以使用Babelmark比较Markdown的实现。

有用的提示:

  • 强制换行,在行末放置两个空格;

  • 要转义特殊字符,请使用\。

答案 6 :(得分:2)

这是一个简单的乳胶示例。

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

导致: enter image description here

不幸的是因为这是乳胶,你不能再在TODO盒子中包含降价(这通常不是一个大问题),并且在转换为PDF以外的格式时它不会起作用(例如html) 。

答案 7 :(得分:2)

另一种解决方案是使用 CSS 邻接并使用 h4(或更高版本):

#### note

This is the note content
h4 {
  display: none; /* hide */
}

h4 + p {
  /* style the note however you want */
}

答案 8 :(得分:1)

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

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

然后呈现为:

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

答案 9 :(得分:1)

类似于Etienne的解决方案,一个简单的表格格式很好:

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

另一种方法(更加强调)是使内容成为无主体表的标题:

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

最后,您可以包括一条水平线(主题间断)以创建一个封闭的框(尽管该线型与表中的标题线略有不同):

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

---

请注意文本后的空白行。

答案 10 :(得分:0)

您是否尝试过使用双标签?制作盒子:

<div
...
  <ng-container
    [ngTemplateOutlet]="tileTemplate"
    [ngTemplateOutletContext]="{ $implicit: content }">
  </ng-container>
...
</div>

它在带有HTML输出的常规Rmarkdown文档中对我有用。双击的部分应显示在一个圆角的矩形浅灰色框中。