Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add Examples section to README with links to real-world use cases.

Browse source
This commit is contained in:
David Anson 2017-11-21 21:58:42 -08:00
parent a74340ed44
commit af968fb246
2 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -612,6 +612,18 @@ var options = {
var results = window.markdownlint.sync(options).toString();
```
## Examples
For ideas how to integrate `markdownlint` into your workflow, refer to the following projects:
* [ally.js](https://allyjs.io/) ([Search repository](https://github.com/medialize/ally.js/search?q=markdownlint))
* [ESLint](https://eslint.org/) ([Search repository](https://github.com/eslint/eslint/search?q=markdownlint))
* [Reactable](https://glittershark.github.io/reactable/) ([Search repository](https://github.com/glittershark/reactable/search?q=markdownlint))
* [Sinon.JS](http://sinonjs.org/) ([Search repository](https://github.com/sinonjs/sinon/search?q=markdownlint))
* [sonarwhal](https://sonarwhal.com/) ([Search repository](https://github.com/sonarwhal/sonarwhal/search?q=markdownlint))
* [TestCafe](https://devexpress.github.io/testcafe/) ([Search repository](https://github.com/DevExpress/testcafe/search?q=markdownlint))
* [webpack](https://webpack.js.org/) ([Search repository](https://github.com/webpack/webpack.js.org/search?q=markdownlint))
## History
* 0.0.1 - Initial release, includes tests MD001-MD032.

1
test/markdownlint-test.js
View file

@ -848,6 +848,7 @@ module.exports.readmeHeaders = function readmeHeaders(test) {
"#### result",
"## Usage",
"## Browser",
"## Examples",
"## History"
]
}