Package detail

@silvermine/markdownlint-rule-indent-alignment

silvermine889MIT0.2.0

A custom markdownlint rule to ensure the proper alignment of indented content

markdownlint, list indentation

readme

markdownlint-rule-indent-alignment

NPM Version License Conventional Commits

What?

This is a custom markdownlint rule to lint the alignment of list items and blocks (e.g. code blocks). For example:

Invalid :no_entry: Valid :white_check_mark: 
Lorem ipsum dolor sit amet
   consectetur adipiscing elit.
 
Lorem ipsum dolor sit amet
consectetur adipiscing elit.
 
* Lorem ipsum
 * Dolor sit amet
 
 Lorem ipsum
   Dolor sit amet
 
1. Lorem ipsum
  * Dolor sit amet
 
1. Lorem ipsum
   * Dolor sit amet
 
* Lorem ipsum dolor sit amet
consectetur adipiscing elit
 
* Lorem ipsum dolor sit amet
  consectetur adipiscing elit
 
1. Lorem ipsum dolor sit amet
     consectetur adipiscing elit
 
1. Lorem ipsum dolor sit amet
   consectetur adipiscing elit
 
* Lorem:

    ```text
    hello world
    ```
 
* Lorem:

  ```text
  hello world
  ```
 
> Lorem ipsum dolor sit amet
 > consectetur adipiscing elit
 
> Lorem ipsum dolor sit amet
> consectetur adipiscing elit

Usage

To use this custom markdownlint rule two things needed:

  1. Update your markdownlint config to include "indent-alignment": true

  2. Add this rule to the list of custom markdownlint rules. If using markdownlint-cli, this would look something like:

    markdownlint -r './node_modules/@silvermine/markdownlint-rule-indent-alignment/src/indent-alignment.js' -c .markdownlint.json README.md

Rule configuration

This rule has the following config options:

  • ul_indent: Desired indention of ul lists (number, default undefined)

    • By default, child ul items will be aligned with the content. When ul_indent is set, the rule will replicate the behavior of the ul-indent (MD007) rule.

    • Examples:

      • ul_indent: undefined

        * top-level item
  * sub-item

      • ul_indent: 3

        * top-level item
   * sub-item

  • start_indent: Desired indention of all top-level lists (number, default undefined)

    • By default, top-level lists are allowed to be indented at any level as long as it's consistent. When start_indent is set, then any top-level list must be indented at that level.

    • Examples:

      • start_indent: 3

           * top-level item
     * sub-item

   1. top-level item
      1. sub-item

License

This software is released under the MIT license. See the license file for more details.