mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-09-19 07:37:57 +03:00
5162a0982b
* Add example rule, and rule object file, to
`test/external`;
* Add fixtures for external tests;
* Move `mdast.js`, `mdast.min.js` to `mdast-lint.js`,
`mdast-lint.min.js`;
* Add docs for external rules.
Closes GH-14.
11 lines
839 B
JSON
Executable File
11 lines
839 B
JSON
Executable File
{
|
|
"reset": {
|
|
"description": "By default, all rules are turned on unless explicitly set to `false`.\nWhen `reset: true`, the opposite is true: all rules are turned off,\nunless when given a non-nully and non-false value.\n\nOptions: `boolean`, default: `false`.",
|
|
"example": " <!-- Explicitly activate rules: -->\n ```json\n {\n \"reset\": true,\n \"final-newline\": true\n }\n ```\n"
|
|
},
|
|
"externals": {
|
|
"description": "Externals contains a list of extra rules to load.\nThese are, or refer to, an object mapping `ruleId`s to rules.\n\nNote that in node.js, a string can be given (a module\nname or a file), but in the browser an object must be passed in.",
|
|
"example": " <!-- Load more rules -->\n ```json\n {\n \"externals\": [\"foo\", \"bar\", \"baz\"]\n }\n ```\n"
|
|
}
|
|
}
|