Skip to content

Commit db4810d

Browse files
committedNov 10, 2023
Refactor remark config
1 parent f8be2e3 commit db4810d

File tree

77 files changed

+1236
-1249
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1236
-1249
lines changed
 

‎.remarkrc.js

-32
This file was deleted.

‎doc/create-a-custom-rule.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ getting started to create your first linting plugin for `remark`.
55

66
## Contents
77

8-
* [Set up the project](#set-up-the-project)
9-
* [Set up remark](#set-up-remark)
10-
* [The `no-invalid-gif` rule](#the-no-invalid-gif-rule)
11-
* [Create the custom rule](#create-the-custom-rule)
12-
* [Rule arguments](#rule-arguments)
13-
* [Rule implementation](#rule-implementation)
14-
* [Import the rule in your remark config](#import-the-rule-in-your-remark-config)
15-
* [Apply the rule on the Markdown file](#apply-the-rule-on-the-markdown-file)
8+
* [Set up the project](#set-up-the-project)
9+
* [Set up remark](#set-up-remark)
10+
* [The `no-invalid-gif` rule](#the-no-invalid-gif-rule)
11+
* [Create the custom rule](#create-the-custom-rule)
12+
* [Rule arguments](#rule-arguments)
13+
* [Rule implementation](#rule-implementation)
14+
* [Import the rule in your remark config](#import-the-rule-in-your-remark-config)
15+
* [Apply the rule on the Markdown file](#apply-the-rule-on-the-markdown-file)
1616

1717
## Set up the project
1818

@@ -32,10 +32,10 @@ Now we can start installing our dependencies:
3232
npm install remark-lint remark-cli
3333
```
3434

35-
* [`remark-lint`][remark-lint]
36-
— core lint plugin
37-
* [`remark-cli`][remark-cli]
38-
— command line interface
35+
* [`remark-lint`][remark-lint]
36+
— core lint plugin
37+
* [`remark-cli`][remark-cli]
38+
— command line interface
3939

4040
We will also use some utilities:
4141

@@ -171,9 +171,9 @@ Your rule function will receive three arguments:
171171
(tree, file, options) => {}
172172
```
173173

174-
* `tree` (*required*): [mdast][]
175-
* `file` (*required*): [virtual file][vfile]
176-
* `options` (*optional*): additional info passed to the rule by users
174+
* `tree` (*required*): [mdast][]
175+
* `file` (*required*): [virtual file][vfile]
176+
* `options` (*optional*): additional info passed to the rule by users
177177

178178
## Rule implementation
179179

0 commit comments

Comments
 (0)
Please sign in to comment.