Skip to content

Commit a0f1279

Browse files
committed
ci: Add Markdownlint configuration
Signed-off-by: 林博仁(Buo-ren Lin) <Buo.Ren.Lin@gmail.com>
1 parent 4da2b21 commit a0f1279

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

.markdownlint.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Markdownlint(Node.js variant) configuration file
2+
# https://github.com/igorshubovych/markdownlint-cli#configuration
3+
#
4+
# This file is based on The Common Markdownlint(Node.js variant) Configuration Templates project
5+
# https://github.com/Lin-Buo-Ren/common-markdownlint-nodejs-config-templates
6+
#
7+
# Copyright 2021 林博仁(Buo-ren, Lin) <Buo.Ren.Lin@gmail.com>
8+
# SPDX-License-Identifier: CC-BY-SA-4.0
9+
10+
# Inherit Markdownlint rules
11+
default: True
12+
13+
# Only allow consistent un-ordered list bullet style(allow alternations in sub-levels)
14+
MD004:
15+
style: sublist
16+
17+
# Only allow 4 spaces as indentation of lists
18+
MD007:
19+
indent: 4
20+
21+
# Only allow 2 spaces as linebreak sequence
22+
MD009:
23+
br_spaces: 2
24+
25+
# Disable line length limitation(not suitable with CJK context)
26+
MD013: False
27+
28+
# Allow missing padding blank line between the heading markup and the context
29+
MD022: False
30+
31+
# Allow duplicated non-sibling heading text
32+
MD024:
33+
siblings_only: True
34+
35+
# Allow missing padding blank line between a list and its context
36+
MD032: False
37+
38+
# Allow using raw HTML markups as workarounds of deficiencies of Markdown
39+
MD033: False
40+
41+
# Allow using YAML front matter, while not require the definition of the
42+
# `title` property
43+
MD041:
44+
front_matter_title: '.*'

0 commit comments

Comments
 (0)