github.com/ddev/ddev@v1.23.2-0.20240519125000-d824ffe36ff3/.markdownlint.jsonc (about) 1 { 2 // These rules mostly come from mkdocs rules 3 // https://github.com/mkdocs/mkdocs/blob/master/.markdownlintrc 4 // Using markdownlint from https://github.com/DavidAnson/markdownlint 5 // and https://github.com/igorshubovych/markdownlint-cli 6 // npm install --global markdownlint-cli 7 8 // Enable all markdownlint rules 9 "default": true, 10 11 // Fine with long lines, editor can wrap 12 "line-length": false, 13 14 // Unfortunately, mkdocs messes up nearly everything if you insist on this; 15 // the problem is that it's concatenating files, so you lose important levels 16 // of sidebar headings if every file starts with H1. 17 "first-line-h1": false, 18 19 "MD004": { "style": "consistent" }, 20 21 // Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.) 22 "MD029": { "style": "ordered" }, 23 24 // Set list indent level to 4 which Python-Markdown requires 25 "MD007": { "indent": 4 }, 26 27 // Embedded html allowed; often used for named anchors with mkdocs/readthedocs 28 "no-inline-html": false, 29 30 // Fenced code blocks do not need language spec 31 "MD040": false, 32 33 // Exclude code block style 34 "MD046": false 35 }