From d34775b19463982b7502a3023e5a5f700f9dcc2c Mon Sep 17 00:00:00 2001 From: oupala Date: Wed, 17 Jun 2020 13:00:27 +0200 Subject: doc: add a markdown linting configuration file Add a markdown linting configuration file. The configuration file is using [remark-preset-lint-markdown-style-guide](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-markdown-style-guide). This preset configure `remark-lint` with settings that the [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/) recommends. Signed-off-by: oupala --- .remarkrc | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .remarkrc (limited to '.remarkrc') diff --git a/.remarkrc b/.remarkrc new file mode 100644 index 00000000..cb20fc41 --- /dev/null +++ b/.remarkrc @@ -0,0 +1,5 @@ +{ + "plugins": [ + "preset-lint-markdown-style-guide" + ] +} -- cgit v1.2.3 From 73219909602e026616af6a97f588bc9e0eab1fa8 Mon Sep 17 00:00:00 2001 From: oupala Date: Wed, 1 Jul 2020 11:50:59 +0200 Subject: fix: override markdown linting preset Override markdown linting preset to disable a rule that seems useless and to change the default setting of 2 other rules. Signed-off-by: oupala --- .remarkrc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to '.remarkrc') diff --git a/.remarkrc b/.remarkrc index cb20fc41..256d54cf 100644 --- a/.remarkrc +++ b/.remarkrc @@ -1,5 +1,9 @@ { "plugins": [ - "preset-lint-markdown-style-guide" + "preset-lint-markdown-style-guide", + + ["lint-list-item-indent", "space"], + ["lint-maximum-line-length", false], + ["lint-ordered-list-marker-value", "ordered"] ] } -- cgit v1.2.3