Skip to content

Commit 85bf134

Browse files
committed
content: Add mdformat configuration
mdformat by default repects wrapping of original file. While this could be changed to apply 80 columns wrapping adopted by Vim. Signed-off-by: Ruoqing He <heruoqing@iscas.ac.cn>
1 parent 42415c1 commit 85bf134

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/repo-management/firecracker/markdown.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,18 @@ specification, so for full GitHub support we should install it with:
2727
```sh
2828
pip install mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
2929
```
30+
31+
## Configuration in Repository
32+
33+
`mdformat` allows configuration specified in `.mdformat.toml` file. Firecracker
34+
community uses the following configuration:
35+
36+
```toml
37+
wrap = 80
38+
# Defaults from https://mdformat.readthedocs.io/en/stable/users/configuration_file.html
39+
number = false
40+
end_of_line = "lf"
41+
```
42+
43+
As of 80 columns wrapping, this is the default behavior I observed of `gq`
44+
command of Vim.

0 commit comments

Comments
 (0)