Skip to content

Commit 9e1d063

Browse files
committed
content: Add Installation guide of mdformat
The installation guide is quoted from [1], for full GitHub markdown features support, additional packages need to be installed. Signed-off-by: Ruoqing He <heruoqing@iscas.ac.cn>
1 parent b22c23a commit 9e1d063

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/repo-management/firecracker/markdown.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,14 @@ It is a good idea to format these files, but I don't prefer doing it without
1616
`--check` flag. I think it would be better to tell developers that some `.md`
1717
files are not in a preferred form that `mdformat` thinks, instead of changing it
1818
directly and developers may well get confuse on what is going to be committed.
19+
20+
## Install mdformat
21+
22+
Installation guide of `mdformat` is documented
23+
[here](https://github.com/executablebooks/mdformat/blob/master/README.md#installing).
24+
GibHub's Markdown renderer supports syntax enxtensions not included in the GFM
25+
specification, so for full GitHub support we should install it with:
26+
27+
```sh
28+
pip install mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
29+
```

0 commit comments

Comments
 (0)