github.com/drud/ddev@v1.21.5-alpha1.0.20230226034409-94fcc4b94453/.markdownlintrc (about)

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