$ 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
Text blocks separated with empty lines are paragraphs.
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 will be used for Syntax highlight. Please check this to see language support.
| A | B | C | D |
|---|:--| :----:| --: |
| a | b | c | d |
| 1 | 2 | 3 | 4 |
---
MathJax@3 works for
$inline-math-tex$
$$display-math-tex$$
@(./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 style shortcodes are available. Awesome cheatsheet is here.
unidoc
uses Handlebars for rendering.
--template
can specify your customized template file (.hbs) and -V
passes free variables.
- title
- PageTtitle
- body
- body HTML
- headers
- Vec of files
--include-in-header
,-H
- befores
- Vec of files
--include-before-body
,-B
- afters
- Vec of files
--include-after-body
,-A
- css
- Vec of files
--css
,-C
- variables
HashMap<String, String>
--variable
,-V
-V KEY:VALUE
in CLI{{variable.KEY}}
in Handlebars