🧲 unidoc: 统一所有Markdown。

安装与使用

$ cargo install unidoc

$ cat example.md | unidoc
$ unidoc example.md -o output.md
$ unidoc input1.md input2.md input3.md -o output.md

$ unidoc --help  # for more detail

语法

文本

*emphasis*
_emphasis_
**strong**
__strong__
***Emphasis and Strong***
~~deleted~~

![alt](image-link-Path-or-URL)

[text](link)

`inline code`

<!-- this is hidden comment -->

标题

% h1
# h1
## h2
### h3
...
###### h6

列表

- one
- two
- three

- any bullet is ok
    + plus
        * astersk

1. ordered with numbers
2. hgoehoge

a. with alphabets
a. hogehoge

- task list
    - [ ] not yet
    - [x] already done

段落，引用

通过空行分隔的文本块是段落。

this is paragraph1.
this is paragraph1.
this is paragraph1.

this is paragraph2.  this is paragraph2.
this is paragraph2.

> This is quoted.  This is quoted.
> This is quoted.

代码块

```
def code():
    return code
```

```python
def code():
    return code
```

将使用Prism.js进行语法高亮。请检查这里查看语言支持。

表格

| A | B |   C   |   D |
|---|:--| :----:| --: |
| a | b |   c   |  d  |
| 1 | 2 |   3   |  4  |

分隔线

---

扩展语法

MathJax支持

MathJax@3适用于

$inline-math-tex$
$$display-math-tex$$

导入另一个Markdown

@(./relative/another.md)

导入代码

@[rust](./sample.rs)

超链接

This is inline hyperlink: [[http://example.com]].

Hyperlink as a block generates Blogcard:

{{ https://cympfh.cc/ }}

😂 表情符号

:(emoji-shortcode):
:joy: :cry: :+1:

提供GitHub风格的短代码。超级速查表在这里。

模板

unidoc使用Handlebars进行渲染。--template可以指定您的自定义模板文件（.hbs），并且-V传递自由变量。

变量（crate::template::Context）

• 标题
  • 页面标题
• 主体
  • 主体HTML
• 标题
  • 文件Vec
  • --include-in-header，-H
• before
  • 文件Vec
  • --include-before-body，-B
• after
  • 文件Vec
  • --include-after-body，-A
• css
  • 文件Vec
  • --css，-C
• 变量
  • HashMap<字符串, 字符串>
  • --variable，-V
    • -V KEY:VALUE在CLI中
    • {{variable.KEY}}在Handlebars中