@md-plugins/shared 1.0.0 → 1.1.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/dist/index.d.mts +4 -14
- package/dist/index.d.ts +4 -14
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -38,7 +38,7 @@ interface MarkdownItHeader {
|
|
|
38
38
|
*/
|
|
39
39
|
children: MarkdownItHeader[];
|
|
40
40
|
}
|
|
41
|
-
type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | { [P in K]?: T } | undefined, key: K, defaults: T) => T;
|
|
41
|
+
type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | { [P in K]?: T; } | undefined, key: K, defaults: T) => T;
|
|
42
42
|
interface ResolveTitleOptions {
|
|
43
43
|
/**
|
|
44
44
|
* Should allow inline HTML tags or not.
|
|
@@ -62,10 +62,7 @@ interface ResolveTitleOptions {
|
|
|
62
62
|
* `heading_open` token. Permalink marker tokens generated by markdown-it-anchor
|
|
63
63
|
* are ignored so the title remains human-readable.
|
|
64
64
|
*/
|
|
65
|
-
declare const resolveTitleFromToken: (token: Token, {
|
|
66
|
-
shouldAllowHtml,
|
|
67
|
-
shouldEscapeText
|
|
68
|
-
}: ResolveTitleOptions) => string;
|
|
65
|
+
declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
|
|
69
66
|
interface ResolveHeadersOptions extends ResolveTitleOptions {
|
|
70
67
|
/**
|
|
71
68
|
* Heading level that going to be resolved
|
|
@@ -94,14 +91,7 @@ interface ResolveHeadersOptions extends ResolveTitleOptions {
|
|
|
94
91
|
* Existing heading `id` attributes are preserved. When a heading has no `id`,
|
|
95
92
|
* the configured `slugify` function creates one from the resolved heading text.
|
|
96
93
|
*/
|
|
97
|
-
declare const resolveHeadersFromTokens: (tokens: Token[], {
|
|
98
|
-
level,
|
|
99
|
-
shouldAllowHtml,
|
|
100
|
-
shouldAllowNested,
|
|
101
|
-
shouldEscapeText,
|
|
102
|
-
slugify,
|
|
103
|
-
format
|
|
104
|
-
}?: Partial<ResolveHeadersOptions>) => MarkdownItHeader[];
|
|
94
|
+
declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldAllowNested, shouldEscapeText, slugify, format }?: Partial<ResolveHeadersOptions>) => MarkdownItHeader[];
|
|
105
95
|
/**
|
|
106
96
|
* Converts arbitrary heading text into a stable URL-friendly slug.
|
|
107
97
|
*
|
|
@@ -117,5 +107,5 @@ declare const slugify$1: (str: string) => string;
|
|
|
117
107
|
* or through a shared md-plugins config object keyed by plugin name. This helper
|
|
118
108
|
* supports both shapes while applying default values.
|
|
119
109
|
*/
|
|
120
|
-
declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | { [key in K]?: T } | undefined, key: K, defaults: T): T;
|
|
110
|
+
declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | { [key in K]?: T; } | undefined, key: K, defaults: T): T;
|
|
121
111
|
export { type MarkdownItEnv, type MarkdownItHeader, ResolveHeadersOptions, type ResolvePluginOptionsFn, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolvePluginOptions, resolveTitleFromToken, slugify$1 as slugify };
|
package/dist/index.d.ts
CHANGED
|
@@ -38,7 +38,7 @@ interface MarkdownItHeader {
|
|
|
38
38
|
*/
|
|
39
39
|
children: MarkdownItHeader[];
|
|
40
40
|
}
|
|
41
|
-
type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | { [P in K]?: T } | undefined, key: K, defaults: T) => T;
|
|
41
|
+
type ResolvePluginOptionsFn = <T extends object, K extends keyof any>(options: T | { [P in K]?: T; } | undefined, key: K, defaults: T) => T;
|
|
42
42
|
interface ResolveTitleOptions {
|
|
43
43
|
/**
|
|
44
44
|
* Should allow inline HTML tags or not.
|
|
@@ -62,10 +62,7 @@ interface ResolveTitleOptions {
|
|
|
62
62
|
* `heading_open` token. Permalink marker tokens generated by markdown-it-anchor
|
|
63
63
|
* are ignored so the title remains human-readable.
|
|
64
64
|
*/
|
|
65
|
-
declare const resolveTitleFromToken: (token: Token, {
|
|
66
|
-
shouldAllowHtml,
|
|
67
|
-
shouldEscapeText
|
|
68
|
-
}: ResolveTitleOptions) => string;
|
|
65
|
+
declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
|
|
69
66
|
interface ResolveHeadersOptions extends ResolveTitleOptions {
|
|
70
67
|
/**
|
|
71
68
|
* Heading level that going to be resolved
|
|
@@ -94,14 +91,7 @@ interface ResolveHeadersOptions extends ResolveTitleOptions {
|
|
|
94
91
|
* Existing heading `id` attributes are preserved. When a heading has no `id`,
|
|
95
92
|
* the configured `slugify` function creates one from the resolved heading text.
|
|
96
93
|
*/
|
|
97
|
-
declare const resolveHeadersFromTokens: (tokens: Token[], {
|
|
98
|
-
level,
|
|
99
|
-
shouldAllowHtml,
|
|
100
|
-
shouldAllowNested,
|
|
101
|
-
shouldEscapeText,
|
|
102
|
-
slugify,
|
|
103
|
-
format
|
|
104
|
-
}?: Partial<ResolveHeadersOptions>) => MarkdownItHeader[];
|
|
94
|
+
declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldAllowNested, shouldEscapeText, slugify, format }?: Partial<ResolveHeadersOptions>) => MarkdownItHeader[];
|
|
105
95
|
/**
|
|
106
96
|
* Converts arbitrary heading text into a stable URL-friendly slug.
|
|
107
97
|
*
|
|
@@ -117,5 +107,5 @@ declare const slugify$1: (str: string) => string;
|
|
|
117
107
|
* or through a shared md-plugins config object keyed by plugin name. This helper
|
|
118
108
|
* supports both shapes while applying default values.
|
|
119
109
|
*/
|
|
120
|
-
declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | { [key in K]?: T } | undefined, key: K, defaults: T): T;
|
|
110
|
+
declare function resolvePluginOptions<T extends object, K extends keyof any>(options: T | { [key in K]?: T; } | undefined, key: K, defaults: T): T;
|
|
121
111
|
export { type MarkdownItEnv, type MarkdownItHeader, ResolveHeadersOptions, type ResolvePluginOptionsFn, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolvePluginOptions, resolveTitleFromToken, slugify$1 as slugify };
|