mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
9a5fc674f3
* chore: add markdownlint-cli2 and config for mkdocs * style: enforce linting rules on mkdocs md files * chore: tweaks to markdownlint rules * style: linting changelog * style: linting release notes * style: linting .github md files * style: further linting of docs * style: linting readmes * chore: update linting script entries * docs: tweak release after rebase * chore: simplify root md linting config * chore: extend base config * chore: implement requested changes * chore: remove unnecessary exception * chore: fix comment type * styling: single config + list spacing * chore: implement requested changes * chore: use .cjs files for markdownlint config * chore: implement requested changes
32 lines
723 B
JavaScript
32 lines
723 B
JavaScript
"use strict";
|
|
|
|
module.exports = {
|
|
ignores: [ "node_modules/", "LICENSE.md" ],
|
|
|
|
globs: [ "**/*.md" ],
|
|
|
|
config: {
|
|
// Enable all markdownlint rules
|
|
default: true,
|
|
|
|
// Set list indent level to 4 which mkdocs / Python-Markdown requires
|
|
MD007: { "indent": 4 },
|
|
|
|
// Enable line length check but exclude tables and code blocks
|
|
MD013: {
|
|
line_length: 120,
|
|
tables: false,
|
|
code_blocks: false
|
|
},
|
|
|
|
// Allow multiple subheadings with the same content
|
|
// across different section (#1 ##A ##B #2 ##A ##B)
|
|
MD024: {
|
|
allow_different_nesting: true
|
|
},
|
|
|
|
// Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
|
|
MD029: { "style": "ordered" }
|
|
}
|
|
};
|