markdownlint-cli2/test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc at main · DavidAnson/markdownlint-cli2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
 * An example .markdownlint-cli2.jsonc file
 */
{
  // Disable some built-in rules
  "config": {
    "no-trailing-spaces": false,
    "no-multiple-blanks": false
  },

  // Include a custom rule package
  "customRules": [
    "markdownlint-rule-extended-ascii"
  ],

  // Fix any fixable errors
  "fix": true,

  // Define a custom front matter pattern
  "frontMatter": "<head>[^]*<\/head>",

  // Ignore files referenced by .gitignore (only valid at root)
  "gitignore": true,

  // Define glob expressions to use (only valid at root)
  "globs": [
    "!*bout.md"
  ],

  // Define glob expressions to ignore
  "ignores": [
    "ignore*.md"
  ],

  // Use a plugin to recognize math
  "markdownItPlugins": [
    [ "markdown-it-emoji/dist/light.cjs.js" ]
  ],

  // Additional paths to resolve module locations from
  "modulePaths": [
    "./modules"
  ],

  // Disable banner message on stdout (only valid at root)
  "noBanner": true,

  // Disable inline config comments
  "noInlineConfig": true,

  // Disable progress on stdout (only valid at root)
  "noProgress": true,

  // Use a specific formatter (only valid at root)
  "outputFormatters": [
    [ "markdownlint-cli2-formatter-default" ]
  ],

  // Disable different rules for some files
  "overrides": [
    // Add another rule for CHANGELOG.md
    {
      "filter": [ "CHANGELOG.md" ],
      "config": {
        "no-duplicate-heading": false
      },
      "combine": "merge"
    },
    // Reset customizations for doc/test directories
    {
      "filter": [ "doc/*.md", "test/*.md" ],
      "config": {},
      "combine": "replace"
    }
  ],

  // Show found files on stdout (only valid at root)
  "showFound": true
}