Skip to content

Commit 341a98a

Browse files
authored
docs: fix typos and improve clarity in README.md (#130)
1 parent 1016256 commit 341a98a

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ type remarkOptions = {
8686
#### plugins
8787

8888
Allows to connect [`remark` plugins](https://github.com/wooorm/remark/blob/master/doc/plugins.md)
89+
8990
Type:
9091

9192
```ts
@@ -127,7 +128,7 @@ module.exports = {
127128

128129
##### array
129130

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`.
131132

132133
**webpack.config.js**
133134

@@ -169,7 +170,8 @@ module.exports = {
169170

170171
#### settings
171172

172-
Remark settings
173+
Remark settings
174+
173175
Type:
174176

175177
```ts
@@ -178,7 +180,7 @@ type settings = Object;
178180

179181
Default: `undefined`
180182

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`.
182184

183185
**webpack.config.js**
184186

@@ -210,7 +212,8 @@ module.exports = {
210212

211213
#### data
212214

213-
Information available to all plugins
215+
Information available to all plugins
216+
214217
Type:
215218

216219
```ts
@@ -219,8 +222,8 @@ type data = Object;
219222

220223
Default: `undefined`
221224

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.
224227

225228
**webpack.config.js**
226229

@@ -310,7 +313,7 @@ This project was inspired the following open source work:
310313

311314
### Markdown to HTML
312315

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`
314317

315318
```js
316319
import md from "markdown-file.md";
@@ -378,7 +381,8 @@ module.exports = {
378381

379382
## Contributing
380383

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.
382386

383387
[CONTRIBUTING](./.github/CONTRIBUTING.md)
384388

0 commit comments

Comments
 (0)