Skip to content

Commit 08444a5

Browse files
authored
Fix typo; minor copy-edits (#879)
1 parent 940459e commit 08444a5

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Diff for: README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ var md = require('markdown-it')()
145145
Apply syntax highlighting to fenced code blocks with the `highlight` option:
146146

147147
```js
148-
var hljs = require('highlight.js'); // https://highlightjs.org/
148+
var hljs = require('highlight.js'); // https://highlightjs.org
149149

150150
// Actual default values
151151
var md = require('markdown-it')({
@@ -164,7 +164,7 @@ var md = require('markdown-it')({
164164
Or with full wrapper override (if you need assign class to `<pre>`):
165165

166166
```js
167-
var hljs = require('highlight.js'); // https://highlightjs.org/
167+
var hljs = require('highlight.js'); // https://highlightjs.org
168168

169169
// Actual default values
170170
var md = require('markdown-it')({
@@ -196,7 +196,7 @@ md.linkify.set({ fuzzyEmail: false }); // disables converting email to link
196196

197197
__[API documentation](https://markdown-it.github.io/markdown-it/)__
198198

199-
If you are going to write plugins - take a look at
199+
If you are going to write plugins, please take a look at
200200
[Development info](https://github.com/markdown-it/markdown-it/tree/master/docs).
201201

202202

@@ -242,8 +242,10 @@ md = require('markdown-it')({
242242
```
243243

244244
You can find all rules in sources:
245-
[parser_core.js](lib/parser_core.js), [parser_block](lib/parser_block.js),
246-
[parser_inline](lib/parser_inline.js).
245+
246+
- [`parser_core.js`](lib/parser_core.js)
247+
- [`parser_block.js`](lib/parser_block.js)
248+
- [`parser_inline.js`](lib/parser_inline.js)
247249

248250

249251
## Benchmark
@@ -265,9 +267,9 @@ Sample: README.md (7774 bytes)
265267
```
266268

267269
__Note.__ CommonMark version runs with [simplified link normalizers](https://github.com/markdown-it/markdown-it/blob/master/benchmark/implementations/current-commonmark/index.js)
268-
for more "honest" compare. Difference is ~ 1.5x.
270+
for more "honest" compare. Difference is ≈1.5×.
269271

270-
As you can see, `markdown-it` doesn't pay with speed for it's flexibility.
272+
As you can see, `markdown-it` doesn't pay with speed for its flexibility.
271273
Slowdown of "full" version caused by additional features not available in
272274
other implementations.
273275

0 commit comments

Comments
 (0)