@mdit-vue/plugin-headers 0.11.1 → 0.12.0
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/README.md +12 -0
- package/dist/index.cjs +7 -3
- package/dist/index.d.ts +8 -0
- package/dist/index.mjs +7 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -59,6 +59,18 @@ console.log(env.headers);
|
|
|
59
59
|
|
|
60
60
|
When using this plugin with [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor) (recommended), this option should be a subset of markdown-it-anchor's `level` option to ensure the header slugs are existed.
|
|
61
61
|
|
|
62
|
+
### shouldAllowNested
|
|
63
|
+
|
|
64
|
+
- Type: `boolean`
|
|
65
|
+
|
|
66
|
+
- Default: `false`
|
|
67
|
+
|
|
68
|
+
- Details:
|
|
69
|
+
|
|
70
|
+
Should allow headers inside nested blocks or not.
|
|
71
|
+
|
|
72
|
+
If set to `true`, headers inside blockquote, list, etc. would also be extracted.
|
|
73
|
+
|
|
62
74
|
### slugify
|
|
63
75
|
|
|
64
76
|
- Type: `(str: string) => string`
|
package/dist/index.cjs
CHANGED
|
@@ -1,15 +1,19 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
-
|
|
5
3
|
const shared = require('@mdit-vue/shared');
|
|
6
4
|
|
|
7
|
-
const headersPlugin = (md, {
|
|
5
|
+
const headersPlugin = (md, {
|
|
6
|
+
level = [2, 3],
|
|
7
|
+
shouldAllowNested = false,
|
|
8
|
+
slugify = shared.slugify,
|
|
9
|
+
format
|
|
10
|
+
} = {}) => {
|
|
8
11
|
const render = md.renderer.render.bind(md.renderer);
|
|
9
12
|
md.renderer.render = (tokens, options, env) => {
|
|
10
13
|
env.headers = shared.resolveHeadersFromTokens(tokens, {
|
|
11
14
|
level,
|
|
12
15
|
shouldAllowHtml: false,
|
|
16
|
+
shouldAllowNested,
|
|
13
17
|
shouldEscapeText: false,
|
|
14
18
|
slugify,
|
|
15
19
|
format
|
package/dist/index.d.ts
CHANGED
|
@@ -26,6 +26,14 @@ interface HeadersPluginOptions {
|
|
|
26
26
|
* @default [2,3]
|
|
27
27
|
*/
|
|
28
28
|
level?: number[];
|
|
29
|
+
/**
|
|
30
|
+
* Should allow headers inside nested blocks or not
|
|
31
|
+
*
|
|
32
|
+
* If set to `true`, headers inside blockquote, list, etc. would also be extracted.
|
|
33
|
+
*
|
|
34
|
+
* @default false
|
|
35
|
+
*/
|
|
36
|
+
shouldAllowNested?: boolean;
|
|
29
37
|
}
|
|
30
38
|
declare module '@mdit-vue/types' {
|
|
31
39
|
interface MarkdownItEnv {
|
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import { resolveHeadersFromTokens, slugify } from '@mdit-vue/shared';
|
|
2
2
|
|
|
3
|
-
const headersPlugin = (md, {
|
|
3
|
+
const headersPlugin = (md, {
|
|
4
|
+
level = [2, 3],
|
|
5
|
+
shouldAllowNested = false,
|
|
6
|
+
slugify: slugify$1 = slugify,
|
|
7
|
+
format
|
|
8
|
+
} = {}) => {
|
|
4
9
|
const render = md.renderer.render.bind(md.renderer);
|
|
5
10
|
md.renderer.render = (tokens, options, env) => {
|
|
6
11
|
env.headers = resolveHeadersFromTokens(tokens, {
|
|
7
12
|
level,
|
|
8
13
|
shouldAllowHtml: false,
|
|
14
|
+
shouldAllowNested,
|
|
9
15
|
shouldEscapeText: false,
|
|
10
16
|
slugify: slugify$1,
|
|
11
17
|
format
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mdit-vue/plugin-headers",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.12.0",
|
|
4
4
|
"description": "A markdown-it plugin to get markdown headers",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"markdown-it",
|
|
@@ -38,16 +38,16 @@
|
|
|
38
38
|
"test": "vitest"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@mdit-vue/shared": "0.
|
|
42
|
-
"@mdit-vue/types": "0.
|
|
41
|
+
"@mdit-vue/shared": "0.12.0",
|
|
42
|
+
"@mdit-vue/types": "0.12.0",
|
|
43
43
|
"@types/markdown-it": "^12.2.3",
|
|
44
44
|
"markdown-it": "^13.0.1"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"markdown-it-anchor": "^8.6.
|
|
47
|
+
"markdown-it-anchor": "^8.6.6"
|
|
48
48
|
},
|
|
49
49
|
"publishConfig": {
|
|
50
50
|
"access": "public"
|
|
51
51
|
},
|
|
52
|
-
"gitHead": "
|
|
52
|
+
"gitHead": "986b6023d3460cadefd409cd5d4b6445af3a05bd"
|
|
53
53
|
}
|