Skip to content

Commit

Permalink
Progress #73
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed May 20, 2024
1 parent 4678b33 commit 835ae78
Showing 1 changed file with 29 additions and 10 deletions.
39 changes: 29 additions & 10 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,29 @@
// Default state for all rules
"default": true,

// Changed to allow indented code
// MkDocs assumes 4 spaces for indentation.
// Markdown assumes 4 spaces for indentation.
// That markdownlint has a different default is the error of markdownlint
"MD007": { "indent": 4 },

// Standard markdown does not allow for two correct consecutive blank lines
// i an admonitions (a.o. the 'question' admonition):
//
// ???- question "A question"
//
// ```
// echo "indented code here :-)
// ````
// [blank line 1 here]
// [blank line 2 here]
//
// Hence we allow 2 consecutive blank lines
//
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
"MD012": {
// Consecutive blank lines, CHANGED FROM 1
"maximum": 100
"maximum": 2
},

// Changed to allow indented code
//
"MD013": {
// Number of characters, CHANGED FROM 80
"line_length": 800,
Expand All @@ -33,16 +46,22 @@
"stern": false
},

// It is common that content creators start their consoles with a dollar,
// likely because they think it is clearer
//MD014/commands-show-output: Show dollar before command : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md014.md
"MD014": false,

// Changed to allow indented code
// Standard markdown does not allow for valid indent code like this:
//
// ???- question "A question"
//
// ```
// echo "indented code here :-)
// ````
//
// Hence we allow valid indented code.
//
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md
"MD046": false
//"MD046": {
// // Block style
// "style": "consistent"
//},

}

0 comments on commit 835ae78

Please sign in to comment.