This commit is contained in:
Titus Wormer 2016-04-26 13:34:51 +02:00
parent 1f2e9a8a91
commit 27d3444e06
3 changed files with 93 additions and 87 deletions

View File

@ -79,12 +79,12 @@ be null or undefined in order to be ignored.
### external
````md
<!-- Load more rules -->
```json
{
"external": ["foo", "bar", "baz"]
}
```
<!-- Load more rules -->
```json
{
"external": ["foo", "bar", "baz"]
}
```
````
External contains a list of extra rules to load.
@ -99,13 +99,13 @@ rules are also loaded.
### reset
````md
<!-- Explicitly activate rules: -->
```json
{
"reset": true,
"final-newline": true
}
```
<!-- Explicitly activate rules: -->
```json
{
"reset": true,
"final-newline": true
}
```
````
By default, all rules are turned on unless explicitly set to `false`.
@ -204,28 +204,28 @@ Options: `boolean`, default: `false`.
### code-block-style
````md
<!-- Valid, when set to `indented` or `consistent`, invalid when set to `fenced` -->
Hello
<!-- Valid, when set to `indented` or `consistent`, invalid when set to `fenced` -->
Hello
...
...
World
World
<!-- Valid, when set to `fenced` or `consistent`, invalid when set to `indented` -->
```
Hello
```
...
```bar
World
```
<!-- Always invalid -->
<!-- Valid, when set to `fenced` or `consistent`, invalid when set to `indented` -->
```
Hello
...
```
World
```
```
...
```bar
World
```
<!-- Always invalid -->
Hello
...
```
World
```
````
Warn when code-blocks do not adhere to a given style.
@ -285,28 +285,28 @@ Options: `boolean`, default: `false`.
### fenced-code-flag
````md
<!-- Valid: -->
```hello
world();
```
<!-- Valid: -->
```hello
world();
```
<!-- Valid: -->
Hello
<!-- Valid: -->
Hello
<!-- Invalid: -->
```
world();
```
<!-- Invalid: -->
```
world();
```
<!-- Valid when given `{allowEmpty: true}`: -->
```
world();
```
<!-- Valid when given `{allowEmpty: true}`: -->
```
world();
```
<!-- Invalid when given `["world"]`: -->
```hello
world();
```
<!-- Invalid when given `["world"]`: -->
```hello
world();
```
````
Warn when fenced code blocks occur without language flag.
@ -324,32 +324,32 @@ Options: `boolean`, default: `false`.
### fenced-code-marker
````md
<!-- Valid by default and `` '`' ``: -->
```foo
bar();
```
<!-- Valid by default and `` '`' ``: -->
```foo
bar();
```
```
baz();
```
```
baz();
```
<!-- Valid by default and `'~'`: -->
~~~foo
bar();
~~~
<!-- Valid by default and `'~'`: -->
~~~foo
bar();
~~~
~~~
baz();
~~~
~~~
baz();
~~~
<!-- Always invalid: -->
~~~foo
bar();
~~~
<!-- Always invalid: -->
~~~foo
bar();
~~~
```
baz();
```
```
baz();
```
````
Warn for violating fenced code markers.
@ -970,24 +970,24 @@ Options: `boolean`, default: `false`.
### no-shell-dollars
````md
<!-- Invalid: -->
```bash
$ echo a
$ echo a > file
```
<!-- Invalid: -->
```bash
$ echo a
$ echo a > file
```
<!-- Valid: -->
```sh
echo a
echo a > file
```
<!-- Valid: -->
```sh
echo a
echo a > file
```
<!-- Also valid: -->
```zsh
$ echo a
a
$ echo a > file
```
<!-- Also valid: -->
```zsh
$ echo a
a
$ echo a > file
```
````
Warn when shell code is prefixed by dollar-characters.

View File

@ -2,6 +2,12 @@
<!--lint disable no-multiple-toplevel-headings -->
3.2.1 / 2016-04-26
==================
* Fix incorrect error in `no-heading-content-indent` ([`1f2e9a8`](https://github.com/wooorm/remark-lint/commit/1f2e9a8))
* Fix CRLF line-endings in `hard-break-spaces` ([`31f5069`](https://github.com/wooorm/remark-lint/commit/31f5069))
3.2.0 / 2016-04-04
==================

View File

@ -1,6 +1,6 @@
{
"name": "remark-lint",
"version": "3.2.0",
"version": "3.2.1",
"description": "Lint markdown with remark",
"license": "MIT",
"keywords": [