@kachkaev/markdownlint-config

0.5.0 • Public • Published

@kachkaev → markdownlint config

Compatible with markdownlint-cli v0.23+. To be used together with @kachkaev/prettier-config. See main.json for rule details.

Adding to project

  1. Install the package:

    npm install -D @kachkaev/markdownlint-config
    ## or
    yarn add -D @kachkaev/markdownlint-config
  2. Create .markdownlint.json with the following contents:

    {
      "extends": "@kachkaev/markdownlint-config"
    }
  3. Create .markdownlintignore. For example,

    ###########################
    ## Specific to Markdownlint
    ###########################
    
    ## Ignore all files (but still allow sub-folder scanning)
    *
    !*/
    
    ## Allow certain file types
    !*.md
    !*.mdx
    
    ########################
    ## Same as in .gitignore
    ########################
    
    # (paste lines from .gitignore here)
  4. Optionally, configure package scripts and a pre-commit hook to make sure that all project files are always formatted. See example in njtpackage.json.

Readme

Keywords

none

Package Sidebar

Install

npm i @kachkaev/markdownlint-config

Weekly Downloads

70

Version

0.5.0

License

MIT

Unpacked Size

2.2 kB

Total Files

3

Last publish

Collaborators

  • kachkaev