marked-prismjs-linenumber 0.0.4 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/readme.md +9 -7
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "marked-prismjs-linenumber",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "Return HTML with line-number structure",
|
|
3
|
+
"version": "0.0.6",
|
|
4
|
+
"description": "Return HTML with prismjs line-number structure",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./index.cjs",
|
|
7
7
|
"module": "./index.mjs",
|
package/readme.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# marked-
|
|
1
|
+
# marked-prismjs-linenumber
|
|
2
2
|
|
|
3
3
|
> A [marked](https://marked.js.org/) renderer that highlights Markdown code blocks with [Prism.js](https://prismjs.com/) and renders line numbers — just like the `line-numbers` plugin, but produced straight from the Markdown parser.
|
|
4
4
|
|
|
@@ -8,20 +8,20 @@
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
npm install marked-
|
|
11
|
+
npm install marked-prismjs-linenumber
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
Or with pnpm / yarn:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
pnpm add marked-
|
|
18
|
-
yarn add marked-
|
|
17
|
+
pnpm add marked-prismjs-linenumber
|
|
18
|
+
yarn add marked-prismjs-linenumber
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
You also need `marked` and `prismjs`:
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
|
-
npm install marked prismjs marked-
|
|
24
|
+
npm install marked prismjs marked-prismjs-linenumber
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
## Required styles
|
|
@@ -46,7 +46,7 @@ npm install marked prismjs marked-prism-linenumber
|
|
|
46
46
|
|
|
47
47
|
```js
|
|
48
48
|
import { marked } from 'marked';
|
|
49
|
-
import { renderer, init } from 'marked-
|
|
49
|
+
import { renderer, init } from 'marked-prismjs-linenumber';
|
|
50
50
|
|
|
51
51
|
// Optional: preload Prism grammars you need.
|
|
52
52
|
// Anything not loaded falls back to escaped plain text.
|
|
@@ -82,6 +82,8 @@ The code block above is rendered as:
|
|
|
82
82
|
</pre>
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
+
[Effect display](https://yz0012.github.io/y_z00blog/Post/%E6%9D%82%E9%A1%B9/%E8%A1%8C%E5%8F%B7%E7%A4%BA%E4%BE%8B.html)
|
|
86
|
+
|
|
85
87
|
Each `<span></span>` inside `.line-numbers-rows` becomes one line number via the Prism line-numbers CSS.
|
|
86
88
|
|
|
87
89
|
## API
|
|
@@ -106,7 +108,7 @@ A `marked` renderer object exposing a single `code({ text, lang })` method. Pass
|
|
|
106
108
|
|
|
107
109
|
```js
|
|
108
110
|
import { marked } from 'marked';
|
|
109
|
-
import { renderer } from 'marked-
|
|
111
|
+
import { renderer } from 'marked-prismjs-linenumber';
|
|
110
112
|
|
|
111
113
|
marked.use({ renderer });
|
|
112
114
|
```
|