Shareable Markdownlint Config

📄 About

Shareable configuration package for markdownlint — a popular linter for Markdown files.

This package provides a consistent and standardized configuration for Markdown linters across projects. By using this package, you can ensure that your Markdown files adhere to the same set of rules and guidelines, improving their readability and maintainability.

→ Purpose

• Make it easy for developers to create Markdown files that meet a minimum standard of quality
• Provide a consistent and standardized configuration for Markdown linters across projects
• Save time and effort by avoiding the need to manually configure markdownlint for each project
• Improve the readability and maintainability of Markdown files

💿 Installation

To use this configuration, you'll need to install @wayofdev/markdownlint-config as a development dependency in your mono-repository.

# Install as dev-dependency in the root of the mono-repository
$ pnpm add -wD \
	markdownlint \
	markdownlint-cli \
	@wayofdev/markdownlint-config

This package should be installed in the root of your mono-repository, where you will create a file .markdownlint.json. Within your monorepo, you should have a structure with directories for your apps and packages, such as:

.
├── .markdownlint.json (root)
├── package.json (root)
├── apps
│   └── my-first-app
│       ├── package.json
│       └── ... (other app files)
└── packages
    └── my-first-package
        ├── package.json
        └── ... (other package files)

→ Configure

1. Create .markdownlint.json file in root of mono-repository and add lines:

   {
     "extends": "./node_modules/@wayofdev/markdownlint-config/index.json"
   }

2. Add scripts to your package.json:

   pnpm pkg set scripts.lint:md="markdownlint --fix **/*.md --ignore '**/node_modules/**' --ignore '**/CHANGELOG.md'"

💻 Usage

→ Running

To manually run linter, use command:

pnpm run lint:md

→ Lint-staged

Config can be added to your lint-staged workflow.

lint-staged.config.js

module.exports = {
  '*.md': ['prettier --cache --write', 'markdownlint'],
}

→ Extending

.markdownlint.json

{
  "extends": "./node_modules/@wayofdev/markdownlint-config/index.json",
  "MD013": false,
}

🤝 License

🧱 Credits and Useful Resources

Based on:

• shareable-configs from waldronmatt
• configs by belgattitude from his repositories

🙆🏼‍♂️ Author Information

This repository was created in 2023 by lotyp / wayofdev.

🙌 Want to Contribute?

Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:

• 🤔 Suggest a feature
• 🐛 Report an issue
• 📖 Improve documentation
• 👨‍💻 Contribute to the code

You are more than welcome. Before contributing, kindly check our guidelines.