https://github.com/the-common/markdownlint-nodejs-config-templates

Provides a common base of Markdownlint(Node.js variant)'s configuration file(.markdownlint.yml) that should be easily adaptable for most project's with little modifications.
https://github.com/the-common/markdownlint-nodejs-config-templates

markdownlint-config template

Last synced: about 2 months ago
JSON representation

Provides a common base of Markdownlint(Node.js variant)'s configuration file(.markdownlint.yml) that should be easily adaptable for most project's with little modifications.

• Host: GitHub
• URL: https://github.com/the-common/markdownlint-nodejs-config-templates
• Owner: the-common
• Created: 2020-10-31T20:02:04.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-25T19:12:56.000Z (4 months ago)
• Last Synced: 2024-08-26T19:59:15.301Z (4 months ago)
• Topics: markdownlint-config, template
• Language: Shell
• Homepage: https://github.com/the-common/markdownlint-nodejs-config-templates
• Size: 87.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSES/CC-BY-SA-4.0.txt

Awesome Lists containing this project

README

        
# The Common Markdownlint(Node.js variant) Configuration Templates

This project provides a common base of Markdownlint(Node.js variant)'s configuration file(.markdownlint.yml) that should be easily adaptable for most project's with little modifications.

  

[![GitHub Actions workflow status badge](https://github.com/the-common/markdownlint-nodejs-config-templates/actions/workflows/check-potential-problems.yml/badge.svg "GitHub Actions workflow status")](https://github.com/the-common/markdownlint-nodejs-config-templates/actions/workflows/check-potential-problems.yml) [![pre-commit enabled badge](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white "This project uses pre-commit to check potential problems")](https://pre-commit.com/) [![REUSE Specification compliance badge](https://api.reuse.software/badge/github.com/the-common/markdownlint-nodejs-config-templates "This project complies to the REUSE specification to decrease software licensing costs")](https://api.reuse.software/info/github.com/the-common/markdownlint-nodejs-config-templates)

## References

* [igorshubovych/markdownlint-cli: MarkdownLint Command Line Interface](https://github.com/igorshubovych/markdownlint-cli#configuration)  

  Official project site

* [markdownlint/Rules.md at main · DavidAnson/markdownlint](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)  

  Description of the official linting rules

## Licensing

Unless otherwise noted(individual file's header/[REUSE.toml](REUSE.toml)), this product is licensed under [the 4.0 International version of the Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/), or any of its more recent versions of your preference.

As an exception of the previous clause, this product can be licensed otherwise under [the 2.0 version of the Apache license](https://www.apache.org/licenses/LICENSE-2.0) _if_ it is used to instantiate/refactor a project based on it rather than using it in the making of another template project.  This allows relicensing the project assets to your liking in your non-template projects with only a conformance requirement of attributing this product somewhere in your project/product credits/acknowledgment/copyright notice documentation/user interface.

This work complies to [the REUSE Specification](https://reuse.software/spec/), refer the [REUSE - Make licensing easy for everyone](https://reuse.software/) website for info regarding the licensing of this product.