# :magnet: unidoc: Unite all Markdown.
## Install & Usage
```sh
$ 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
```
## Syntax
### Text
```markdown
*emphasis*
_emphasis_
**strong**
__strong__
***Emphasis and Strong***
~~deleted~~
[text](link)
`inline code`
```
### Headings
```markdown
% h1
# h1
## h2
### h3
...
###### h6
```
### List
```markdown
- 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
```
### Paragraph, Quoting
Text blocks separated with empty lines are paragraphs.
```markdown
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.
```
### Code block
````markdown
```
def code():
return code
```
```python
def code():
return code
```
````
Prism.js will be used for Syntax highlight.
Please check [this](https://prismjs.com/#basic-usage) to see language support.
### Table
```markdown
| A | B | C | D |
|---|:--| :----:| --: |
| a | b | c | d |
| 1 | 2 | 3 | 4 |
```
### Hr
```markdown
---
```
## Extended Syntax
### MathJax Support
MathJax@3 works for
```markdown
$inline-math-tex$
$$display-math-tex$$
```
### Import Another Markdown
```markdown
@(./relative/another.md)
```
### Import Code
```markdown
@[rust](./sample.rs)
```
### Hyperlink
```markdown
This is inline hyperlink: [[http://example.com]].
```
```markdown
Hyperlink as a block generates Blogcard:
{{ https://cympfh.cc/ }}
```
## :joy: Emojis
```markdown
:(emoji-shortcode):
:joy: :cry: :+1:
```
Github style shortcodes are available.
Awesome cheatsheet is [here](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md).
## Template
`unidoc` uses Handlebars for rendering.
`--template` can specify your customized template file (.hbs) and `-V` passes free variables.
### Variable (`crate::template::Context`)
- 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`
- `--variable`, `-V`
- `-V KEY:VALUE` in CLI
- `{{variable.KEY}}` in Handlebars