@terminal-nerds/markdownlint-config

➡️ Extendable markdownlint configuration, part of the terminal-nerds/configs project.

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest markdownlint CLI version

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev markdownlint-cli @terminal-nerds/markdownlint-config

2. Create a markdownlint configuration file - .markdownlint.json.

3. Extend this module package configuration.

   {
   	"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json",
   	"extends": "@terminal-nerds/markdownlint-config"
   }

📖 For the markdownlint CLI usage, please refer to its documentation.

Used configurations & plugins

None, so far.

Security

🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.

Contributing

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (terminal-nerds/configs) project's CONTRIBUTING file for more information if you wish to get involved.

License

⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.