UNPKG

1.43 kBMarkdownView Raw
1# standard-markdown
2
3Test your Markdown files for Standard JavaScript Style™
4
5## Installation
6
7```sh
8npm install standard-markdown --save
9```
10
11## Usage
12
13This module works just like `standard`, but instead of linting javascript files, it lints GitHub-Flavored `js` and `javascript` code blocks inside markdown files.
14
15Lint everything in the current directory:
16
17```sh
18standard-markdown
19```
20
21Or lint some other directory:
22
23```sh
24standard-markdown some/other/directory
25```
26
27All files with `.md` or `.markdown` extension are linted, and the following directories are ignored:
28
29- `.git`
30- `node_modules`
31- `vendor`
32
33## Tests
34
35```sh
36npm install
37npm test
38```
39
40## Dependencies
41
42- [async](https://github.com/caolan/async): Higher-order functions and common patterns for asynchronous code
43- [globby](https://github.com/sindresorhus/globby): Extends `glob` with support for multiple patterns and exposes a Promise API
44- [lodash.flatten](https://github.com/lodash/lodash): The lodash method `_.flatten` exported as a module.
45- [lodash.range](https://github.com/lodash/lodash): The lodash method `_.range` exported as a module.
46- [standard](https://github.com/feross/standard): JavaScript Standard Style
47
48## Dev Dependencies
49
50- [tap-spec](https://github.com/scottcorgan/tap-spec): Formatted TAP output like Mocha's spec reporter
51- [tape](https://github.com/substack/tape): tap-producing test harness for node and browsers
52
53
54## License
55
56MIT