remark-lint-no-paragraph-content-indent

2019-10-09 admin

remark-lint-no-paragraph-content-indent是什么

什么是remark-lint-no-paragraph-content-indent,remark-lint rule to warn when the content in paragraphs are indented

remark-lint-no-paragraph-content-indent使用教程帮助文档

remark-lint-no-paragraph-content-indent

Build Coverage Downloads Size Sponsors Backers Chat

Warn when the content in paragraphs is indented.

Presets

This rule is not included in any default preset

Example

valid.md
In
Alpha

Bravo
Charlie.
**Delta**.

*   Echo
    Foxtrot.

> Golf
> Hotel.

`india()`
juliett.

-   `kilo()`
    lima.

-   `mike()` - november.

![image]() text

![image reference][] text

[![][text]][text]
Out

No messages.

invalid.md
In

Note: · represents a space.

·Alpha

Bravo
·Charlie.
**·Delta**.

*   Echo
    ·Foxtrot.

> Golf
> ·Hotel.

`india()`
·juliett.

-   `kilo()`
    ·lima.

![ image]() text

![ image reference][] text

[![ ][text]][text]
Out
1:1: Expected no indentation in paragraph content
4:1: Expected no indentation in paragraph content
5:3: Expected no indentation in paragraph content
8:5: Expected no indentation in paragraph content
11:3: Expected no indentation in paragraph content
14:1: Expected no indentation in paragraph content
17:5: Expected no indentation in paragraph content
19:1: Expected no indentation in paragraph content
21:1: Expected no indentation in paragraph content
23:2: Expected no indentation in paragraph content

Install

npm:

npm install remark-lint-no-paragraph-content-indent

Use

You probably want to use it on the CLI through a config file:

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-no-paragraph-content-indent",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-no-paragraph-content-indent readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-paragraph-content-indent'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-76944.html

文章标题:remark-lint-no-paragraph-content-indent

回到顶部