You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-8Lines changed: 12 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,7 @@ type remarkOptions = {
86
86
#### plugins
87
87
88
88
Allows to connect [`remark` plugins](https://github.com/wooorm/remark/blob/master/doc/plugins.md)
89
+
89
90
Type:
90
91
91
92
```ts
@@ -127,7 +128,7 @@ module.exports = {
127
128
128
129
##### array
129
130
130
-
If need to specify options for the plugin, can pass the plugin using an array, where the second argument will be options.
131
+
If need to specify options for the plugin, you can pass the plugin using an array, where the second argument will be the `options`.
131
132
132
133
**webpack.config.js**
133
134
@@ -169,7 +170,8 @@ module.exports = {
169
170
170
171
#### settings
171
172
172
-
Remark settings
173
+
Remark settings
174
+
173
175
Type:
174
176
175
177
```ts
@@ -178,7 +180,7 @@ type settings = Object;
178
180
179
181
Default: `undefined`
180
182
181
-
Pass [`remark-stringify` options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options) and [`remark-parse` options](https://github.com/remarkjs/remark/tree/main/packages/remark-parse#options)options to the`remark`.
183
+
Pass [`remark-stringify` options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options) and [`remark-parse` options](https://github.com/remarkjs/remark/tree/main/packages/remark-parse#options)to`remark`.
182
184
183
185
**webpack.config.js**
184
186
@@ -210,7 +212,8 @@ module.exports = {
210
212
211
213
#### data
212
214
213
-
Information available to all plugins
215
+
Information available to all plugins
216
+
214
217
Type:
215
218
216
219
```ts
@@ -219,8 +222,8 @@ type data = Object;
219
222
220
223
Default: `undefined`
221
224
222
-
Configure the [`remark`](https://github.com/unifiedjs/unified#processordatakey-value) with information available to all plugins.
223
-
Information is stored in an in-memory key-value store.
225
+
Configure [`remark`](https://github.com/unifiedjs/unified#processordatakey-value) with information available to all plugins.
226
+
This information is stored in an in-memory key-value store.
224
227
225
228
**webpack.config.js**
226
229
@@ -310,7 +313,7 @@ This project was inspired the following open source work:
310
313
311
314
### Markdown to HTML
312
315
313
-
To get html, need to add [`remark-html`](https://github.com/wooorm/remark-html) to the remark plugins and add [`html-loader`](https://github.com/webpack-contrib/html-loader) to the`webpack.config`
316
+
To get HTML, you need to add [`remark-html`](https://github.com/wooorm/remark-html) to the remark plugins and add [`html-loader`](https://github.com/webpack-contrib/html-loader) to your`webpack.config.js`
314
317
315
318
```js
316
319
importmdfrom"markdown-file.md";
@@ -378,7 +381,8 @@ module.exports = {
378
381
379
382
## Contributing
380
383
381
-
Please take a moment to read our contributing guidelines if you haven't yet done so.
384
+
We welcome all contributions!
385
+
If you're new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.
0 commit comments