@vuepress/markdown 2.0.0-beta.46 → 2.0.0-beta.49

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export * from './markdown';
 export * from './plugins';
 export * from './types';
-export * from './utils';

package/lib/index.js

@@ -17,4 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./markdown"), exports);
 __exportStar(require("./plugins"), exports);
 __exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);

package/lib/markdown.d.ts

@@ -2,4 +2,4 @@ import type { Markdown, MarkdownOptions } from './types';
 /**
  * Create vuepress customized markdown-it instance
  */
-export declare const createMarkdown: ({ anchor, assets, code, customComponent, emoji, extractHeaders, extractTitle, hoistTags, importCode, links, toc, ...markdownItOptions }?: MarkdownOptions) => Markdown;
+export declare const createMarkdown: ({ anchor, assets, code, component, emoji, frontmatter, headers, title, importCode, links, sfc, slugify, toc, ...markdownItOptions }?: MarkdownOptions) => Markdown;

package/lib/markdown.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMarkdown = void 0;
+const shared_1 = require("@mdit-vue/shared");
 const MarkdownIt = require("markdown-it");
 const plugins_1 = require("./plugins");
-const utils_1 = require("./utils");
 /**
  * Create vuepress customized markdown-it instance
  */
-const createMarkdown = ({ anchor, assets, code, customComponent, emoji, extractHeaders, extractTitle, hoistTags, importCode, links, toc, ...markdownItOptions } = {}) => {
+const createMarkdown = ({ anchor, assets, code, component, emoji, frontmatter, headers, title, importCode, links, sfc, slugify = shared_1.slugify, toc, ...markdownItOptions } = {}) => {
     // create raw markdown-it instance
     const md = MarkdownIt({
         ...markdownItOptions,
@@ -25,7 +25,7 @@ const createMarkdown = ({ anchor, assets, code, customComponent, emoji, extractH
     if (anchor !== false) {
         md.use(plugins_1.anchorPlugin, {
             level: [1, 2, 3, 4, 5, 6],
-            slugify: utils_1.slugify,
+            slugify,
             permalink: plugins_1.anchorPlugin.permalink.ariaHidden({
                 class: 'header-anchor',
                 symbol: '#',
@@ -39,37 +39,48 @@ const createMarkdown = ({ anchor, assets, code, customComponent, emoji, extractH
     if (toc !== false) {
         md.use(plugins_1.tocPlugin, {
             level: [2, 3],
-            slugify: utils_1.slugify,
-            linkTag: 'RouterLink',
+            slugify,
+            linkTag: 'router-link',
             ...toc,
         });
     }
     // extract headers into env
-    if (extractHeaders !== false) {
-        md.use(plugins_1.extractHeadersPlugin, {
+    if (headers !== false) {
+        md.use(plugins_1.headersPlugin, {
             level: [2, 3],
-            slugify: utils_1.slugify,
-            ...extractHeaders,
+            slugify,
+            ...headers,
         });
     }
     // extract title into env
-    if (extractTitle !== false) {
-        md.use(plugins_1.extractTitlePlugin);
+    if (title !== false) {
+        md.use(plugins_1.titlePlugin);
     }
     // =====================================================
     // following plugins modify or replace the rule in place
     // and have no conflicts, so the order is not important
-    // treat unknown html tags as custom components
-    if (customComponent !== false) {
-        md.use(plugins_1.customComponentPlugin);
+    // treat unknown html tags as components
+    if (component !== false) {
+        md.use(plugins_1.componentPlugin);
+    }
+    // extract frontmatter and excerpt into env
+    if (frontmatter !== false) {
+        md.use(plugins_1.frontmatterPlugin, {
+            ...frontmatter,
+            grayMatterOptions: {
+                excerpt: true,
+                excerpt_separator: '<!-- more -->',
+                ...frontmatter?.grayMatterOptions,
+            },
+        });
     }
     // replace relative link of assets with absolute link
     if (assets !== false) {
         md.use(plugins_1.assetsPlugin, assets);
     }
-    // hoist vue SFC blocks and extract them into env
-    if (hoistTags !== false) {
-        md.use(plugins_1.hoistTagsPlugin, hoistTags);
+    // extract vue SFC blocks into env
+    if (sfc !== false) {
+        md.use(plugins_1.sfcPlugin, sfc);
     }
     // process external and internal links
     if (links !== false) {

package/lib/plugins/emojiPlugin.d.ts

@@ -1,25 +1,3 @@
-import type { PluginWithOptions } from 'markdown-it';
-/**
- * Options for markdown-it-emoji
- *
- * @see https://github.com/markdown-it/markdown-it-emoji
- */
-export interface EmojiPluginOptions {
-    /**
-     * rewrite available emoji definitions
-     *
-     * @example `{ name1: char1, name2: char2, ... }`
-     */
-    defs?: Record<string, string>;
-    /**
-     * disable all emojis except whitelisted
-     */
-    enabled?: string[];
-    /**
-     * rewrite default shortcuts
-     *
-     * @example `{ "smile": [ ":)", ":-)" ], "laughing": ":D" }`
-     */
-    shortcuts?: Record<string, string | string[]>;
-}
-export declare const emojiPlugin: PluginWithOptions<EmojiPluginOptions>;
+import * as emojiPlugin from 'markdown-it-emoji';
+export declare type EmojiPluginOptions = emojiPlugin.Options;
+export { emojiPlugin };

package/lib/plugins/emojiPlugin.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emojiPlugin = void 0;
-const rawEmojiPlugin = require("markdown-it-emoji");
-exports.emojiPlugin = rawEmojiPlugin;
+const emojiPlugin = require("markdown-it-emoji");
+exports.emojiPlugin = emojiPlugin;

package/lib/plugins/index.d.ts

@@ -1,11 +1,12 @@
+export * from '@mdit-vue/plugin-component';
+export * from '@mdit-vue/plugin-frontmatter';
+export * from '@mdit-vue/plugin-headers';
+export * from '@mdit-vue/plugin-sfc';
+export * from '@mdit-vue/plugin-title';
+export * from '@mdit-vue/plugin-toc';
 export * from './anchorPlugin';
 export * from './assetsPlugin';
 export * from './codePlugin';
-export * from './customComponentPlugin';
 export * from './emojiPlugin';
-export * from './extractHeadersPlugin';
-export * from './extractTitlePlugin';
-export * from './hoistTagsPlugin';
 export * from './importCodePlugin';
 export * from './linksPlugin';
-export * from './tocPlugin';

package/lib/plugins/index.js

@@ -14,14 +14,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@mdit-vue/plugin-component"), exports);
+__exportStar(require("@mdit-vue/plugin-frontmatter"), exports);
+__exportStar(require("@mdit-vue/plugin-headers"), exports);
+__exportStar(require("@mdit-vue/plugin-sfc"), exports);
+__exportStar(require("@mdit-vue/plugin-title"), exports);
+__exportStar(require("@mdit-vue/plugin-toc"), exports);
 __exportStar(require("./anchorPlugin"), exports);
 __exportStar(require("./assetsPlugin"), exports);
 __exportStar(require("./codePlugin"), exports);
-__exportStar(require("./customComponentPlugin"), exports);
 __exportStar(require("./emojiPlugin"), exports);
-__exportStar(require("./extractHeadersPlugin"), exports);
-__exportStar(require("./extractTitlePlugin"), exports);
-__exportStar(require("./hoistTagsPlugin"), exports);
 __exportStar(require("./importCodePlugin"), exports);
 __exportStar(require("./linksPlugin"), exports);
-__exportStar(require("./tocPlugin"), exports);

package/lib/types.d.ts

@@ -1,18 +1,21 @@
+import type { MarkdownItEnv } from '@mdit-vue/types';
 import type { PageFrontmatter, PageHeader } from '@vuepress/shared';
 import type * as MarkdownIt from 'markdown-it';
-import type { AnchorPluginOptions, AssetsPluginOptions, CodePluginOptions, EmojiPluginOptions, ExtractHeadersPluginOptions, HoistTagsPluginOptions, ImportCodePluginOptions, LinksPluginOptions, TocPluginOptions } from './plugins';
+import type { AnchorPluginOptions, AssetsPluginOptions, CodePluginOptions, EmojiPluginOptions, FrontmatterPluginOptions, HeadersPluginOptions, ImportCodePluginOptions, LinksPluginOptions, SfcPluginOptions, TocPluginOptions } from './plugins';
 export declare type Markdown = MarkdownIt;
 export interface MarkdownOptions extends MarkdownIt.Options {
     anchor?: false | AnchorPluginOptions;
     assets?: false | AssetsPluginOptions;
     code?: false | CodePluginOptions;
-    customComponent?: false;
+    component?: false;
     emoji?: false | EmojiPluginOptions;
-    extractHeaders?: false | ExtractHeadersPluginOptions;
-    extractTitle?: false;
-    hoistTags?: false | HoistTagsPluginOptions;
+    frontmatter?: false | FrontmatterPluginOptions;
+    headers?: false | HeadersPluginOptions;
+    title?: false;
     importCode?: false | ImportCodePluginOptions;
     links?: false | LinksPluginOptions;
+    sfc?: false | SfcPluginOptions;
+    slugify?: MarkdownSlugifyFunction;
     toc?: false | TocPluginOptions;
 }
 /**
@@ -36,7 +39,7 @@ export interface MarkdownLink {
  *
  * Output some resources from the markdown file
  */
-export interface MarkdownEnv {
+export interface MarkdownEnv extends MarkdownItEnv {
     /**
      * Base / publicPath of current site
      */
@@ -53,14 +56,6 @@ export interface MarkdownEnv {
      * Frontmatter of the markdown file
      */
     frontmatter?: PageFrontmatter;
-    /**
-     * Headers that extracted by extractHeadersPlugin
-     */
-    headers?: MarkdownHeader[];
-    /**
-     * Hoisted tags that extracted by hoistTagsPlugin
-     */
-    hoistedTags?: string[];
     /**
      * Imported file that extracted by importCodePlugin
      */
@@ -69,8 +64,8 @@ export interface MarkdownEnv {
      * Links that extracted by linksPlugin
      */
     links?: MarkdownLink[];
-    /**
-     * Title that extracted by extractTitlePlugin
-     */
-    title?: string;
 }
+/**
+ * Type of `slugify` function
+ */
+export declare type MarkdownSlugifyFunction = (str: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/markdown",
-  "version": "2.0.0-beta.46",
+  "version": "2.0.0-beta.49",
   "description": "Markdown package of VuePress",
   "keywords": [
     "vuepress",
@@ -22,9 +22,18 @@
     "lib"
   ],
   "dependencies": {
+    "@mdit-vue/plugin-component": "^0.6.0",
+    "@mdit-vue/plugin-frontmatter": "^0.6.0",
+    "@mdit-vue/plugin-headers": "^0.6.0",
+    "@mdit-vue/plugin-sfc": "^0.6.0",
+    "@mdit-vue/plugin-title": "^0.6.0",
+    "@mdit-vue/plugin-toc": "^0.6.0",
+    "@mdit-vue/shared": "^0.6.0",
+    "@mdit-vue/types": "^0.6.0",
     "@types/markdown-it": "^12.2.3",
-    "@vuepress/shared": "2.0.0-beta.46",
-    "@vuepress/utils": "2.0.0-beta.46",
+    "@types/markdown-it-emoji": "^2.0.2",
+    "@vuepress/shared": "2.0.0-beta.49",
+    "@vuepress/utils": "2.0.0-beta.49",
     "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^8.6.4",
     "markdown-it-emoji": "^2.0.2",

package/lib/plugins/customComponentPlugin/customComponentPlugin.d.ts

@@ -1,6 +0,0 @@
-import type { PluginSimple } from 'markdown-it';
-/**
- * Replacing the default htmlBlock rule to allow using custom components
- * in markdown
- */
-export declare const customComponentPlugin: PluginSimple;

package/lib/plugins/customComponentPlugin/customComponentPlugin.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.customComponentPlugin = void 0;
-const htmlBlockRule_1 = require("./htmlBlockRule");
-const htmlInlineRule_1 = require("./htmlInlineRule");
-/**
- * Replacing the default htmlBlock rule to allow using custom components
- * in markdown
- */
-const customComponentPlugin = (md) => {
-    // override default html block ruler
-    md.block.ruler.at('html_block', htmlBlockRule_1.htmlBlockRule, {
-        alt: ['paragraph', 'reference', 'blockquote'],
-    });
-    // override default html inline ruler
-    md.inline.ruler.at('html_inline', htmlInlineRule_1.htmlInlineRule);
-};
-exports.customComponentPlugin = customComponentPlugin;

package/lib/plugins/customComponentPlugin/htmlBlockRule.d.ts

@@ -1,2 +0,0 @@
-import type { RuleBlock } from 'markdown-it/lib/parser_block';
-export declare const htmlBlockRule: RuleBlock;

package/lib/plugins/customComponentPlugin/htmlBlockRule.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.htmlBlockRule = void 0;
-const blockNames = require("markdown-it/lib/common/html_blocks");
-const htmlRe_1 = require("./htmlRe");
-const inlineTags_1 = require("./inlineTags");
-const vueReservedTags_1 = require("./vueReservedTags");
-// Forked and modified from 'markdown-it/lib/rules_block/html_block.js'
-// An array of opening and corresponding closing sequences for html tags,
-// last argument defines whether it can terminate a paragraph or not
-const HTML_SEQUENCES = [
-    [/^<(script|pre|style)(?=(\s|>|$))/i, /<\/(script|pre|style)>/i, true],
-    [/^<!--/, /-->/, true],
-    [/^<\?/, /\?>/, true],
-    [/^<![A-Z]/, />/, true],
-    [/^<!\[CDATA\[/, /\]\]>/, true],
-    // MODIFIED HERE: Treat vue reserved tags as block tags
-    [
-        new RegExp('^</?(' + vueReservedTags_1.vueReservedTags.join('|') + ')(?=(\\s|/?>|$))', 'i'),
-        /^$/,
-        true,
-    ],
-    // MODIFIED HERE: Treat unknown tags as block tags (custom components), excluding known inline tags
-    [
-        new RegExp('^</?(?!(' + inlineTags_1.inlineTags.join('|') + ')(?![\\w-]))\\w[\\w-]*[\\s/>]'),
-        /^$/,
-        true,
-    ],
-    [
-        new RegExp('^</?(' + blockNames.join('|') + ')(?=(\\s|/?>|$))', 'i'),
-        /^$/,
-        true,
-    ],
-    [new RegExp(htmlRe_1.HTML_OPEN_CLOSE_TAG_RE.source + '\\s*$'), /^$/, false],
-];
-const htmlBlockRule = (state, startLine, endLine, silent) => {
-    let i;
-    let nextLine;
-    let lineText;
-    let pos = state.bMarks[startLine] + state.tShift[startLine];
-    let max = state.eMarks[startLine];
-    // if it's indented more than 3 spaces, it should be a code block
-    if (state.sCount[startLine] - state.blkIndent >= 4) {
-        return false;
-    }
-    if (!state.md.options.html) {
-        return false;
-    }
-    if (state.src.charCodeAt(pos) !== 0x3c /* < */) {
-        return false;
-    }
-    lineText = state.src.slice(pos, max);
-    for (i = 0; i < HTML_SEQUENCES.length; i++) {
-        if (HTML_SEQUENCES[i][0].test(lineText)) {
-            break;
-        }
-    }
-    if (i === HTML_SEQUENCES.length) {
-        return false;
-    }
-    if (silent) {
-        // true if this sequence can be a terminator, false otherwise
-        return HTML_SEQUENCES[i][2];
-    }
-    nextLine = startLine + 1;
-    // If we are here - we detected HTML block.
-    // Let's roll down till block end.
-    if (!HTML_SEQUENCES[i][1].test(lineText)) {
-        for (; nextLine < endLine; nextLine++) {
-            if (state.sCount[nextLine] < state.blkIndent) {
-                break;
-            }
-            pos = state.bMarks[nextLine] + state.tShift[nextLine];
-            max = state.eMarks[nextLine];
-            lineText = state.src.slice(pos, max);
-            if (HTML_SEQUENCES[i][1].test(lineText)) {
-                if (lineText.length !== 0) {
-                    nextLine++;
-                }
-                break;
-            }
-        }
-    }
-    state.line = nextLine;
-    const token = state.push('html_block', '', 0);
-    token.map = [startLine, nextLine];
-    token.content = state.getLines(startLine, nextLine, state.blkIndent, true);
-    return true;
-};
-exports.htmlBlockRule = htmlBlockRule;

package/lib/plugins/customComponentPlugin/htmlInlineRule.d.ts

@@ -1,2 +0,0 @@
-import type { RuleInline } from 'markdown-it/lib/parser_inline';
-export declare const htmlInlineRule: RuleInline;

package/lib/plugins/customComponentPlugin/htmlInlineRule.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.htmlInlineRule = void 0;
-const htmlRe_1 = require("./htmlRe");
-// Forked and modified from 'markdown-it/lib/rules_inline/html_inline.js'
-const isLetter = (ch) => {
-    const lc = ch | 0x20; // to lower case
-    return lc >= 0x61 /* a */ && lc <= 0x7a; /* z */
-};
-const htmlInlineRule = (state, silent) => {
-    const pos = state.pos;
-    if (!state.md.options.html) {
-        return false;
-    }
-    // Check start
-    const max = state.posMax;
-    if (state.src.charCodeAt(pos) !== 0x3c /* < */ || pos + 2 >= max) {
-        return false;
-    }
-    // Quick fail on second char
-    const ch = state.src.charCodeAt(pos + 1);
-    if (ch !== 0x21 /* ! */ &&
-        ch !== 0x3f /* ? */ &&
-        ch !== 0x2f /* / */ &&
-        !isLetter(ch)) {
-        return false;
-    }
-    // MODIFIED HERE: Tweak the original HTML_TAG_RE
-    const match = state.src.slice(pos).match(htmlRe_1.HTML_TAG_RE);
-    if (!match) {
-        return false;
-    }
-    if (!silent) {
-        const token = state.push('html_inline', '', 0);
-        token.content = state.src.slice(pos, pos + match[0].length);
-    }
-    state.pos += match[0].length;
-    return true;
-};
-exports.htmlInlineRule = htmlInlineRule;

package/lib/plugins/customComponentPlugin/htmlRe.d.ts

@@ -1,2 +0,0 @@
-export declare const HTML_TAG_RE: RegExp;
-export declare const HTML_OPEN_CLOSE_TAG_RE: RegExp;

package/lib/plugins/customComponentPlugin/htmlRe.js

@@ -1,33 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/naming-convention */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HTML_OPEN_CLOSE_TAG_RE = exports.HTML_TAG_RE = void 0;
-// Forked and modified from 'markdown-it/lib/common/html_re.js'
-// Regexps to match html elements
-// MODIFIED HERE: Support `@` as the first char of attr name
-const attr_name = '[a-zA-Z_:@][a-zA-Z0-9:._-]*';
-const unquoted = '[^"\'=<>`\\x00-\\x20]+';
-const single_quoted = "'[^']*'";
-const double_quoted = '"[^"]*"';
-const attr_value = '(?:' + unquoted + '|' + single_quoted + '|' + double_quoted + ')';
-const attribute = '(?:\\s+' + attr_name + '(?:\\s*=\\s*' + attr_value + ')?)';
-const open_tag = '<[A-Za-z][A-Za-z0-9\\-]*' + attribute + '*\\s*\\/?>';
-const close_tag = '<\\/[A-Za-z][A-Za-z0-9\\-]*\\s*>';
-const comment = '<!---->|<!--(?:-?[^>-])(?:-?[^-])*-->';
-const processing = '<[?][\\s\\S]*?[?]>';
-const declaration = '<![A-Z]+\\s+[^>]*>';
-const cdata = '<!\\[CDATA\\[[\\s\\S]*?\\]\\]>';
-exports.HTML_TAG_RE = new RegExp('^(?:' +
-    open_tag +
-    '|' +
-    close_tag +
-    '|' +
-    comment +
-    '|' +
-    processing +
-    '|' +
-    declaration +
-    '|' +
-    cdata +
-    ')');
-exports.HTML_OPEN_CLOSE_TAG_RE = new RegExp('^(?:' + open_tag + '|' + close_tag + ')');

package/lib/plugins/customComponentPlugin/index.d.ts

@@ -1,6 +0,0 @@
-export * from './customComponentPlugin';
-export * from './htmlBlockRule';
-export * from './htmlInlineRule';
-export * from './htmlRe';
-export * from './inlineTags';
-export * from './vueReservedTags';

package/lib/plugins/customComponentPlugin/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./customComponentPlugin"), exports);
-__exportStar(require("./htmlBlockRule"), exports);
-__exportStar(require("./htmlInlineRule"), exports);
-__exportStar(require("./htmlRe"), exports);
-__exportStar(require("./inlineTags"), exports);
-__exportStar(require("./vueReservedTags"), exports);

package/lib/plugins/customComponentPlugin/inlineTags.d.ts

@@ -1,18 +0,0 @@
-/**
- * According to markdown spec, all non-block html tags are treated as "inline"
- * tags (wrapped with <p></p>), including those "unknown" tags
- *
- * Therefore, markdown-it processes "inline" tags and "unknown" tags in the same
- * way, and does not care if a tag is "inline" or "unknown"
- *
- * As we want to take those "unknown" tags as custom components, we should
- * treat them as "block" tags
- *
- * So we have to distinguish between "inline" and "unknown" tags ourselves
- *
- * The inline tags list comes from MDN
- *
- * @see https://spec.commonmark.org/0.29/#raw-html
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Inline_elements
- */
-export declare const inlineTags: string[];

package/lib/plugins/customComponentPlugin/inlineTags.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.inlineTags = void 0;
-/**
- * According to markdown spec, all non-block html tags are treated as "inline"
- * tags (wrapped with <p></p>), including those "unknown" tags
- *
- * Therefore, markdown-it processes "inline" tags and "unknown" tags in the same
- * way, and does not care if a tag is "inline" or "unknown"
- *
- * As we want to take those "unknown" tags as custom components, we should
- * treat them as "block" tags
- *
- * So we have to distinguish between "inline" and "unknown" tags ourselves
- *
- * The inline tags list comes from MDN
- *
- * @see https://spec.commonmark.org/0.29/#raw-html
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Inline_elements
- */
-exports.inlineTags = [
-    'a',
-    'abbr',
-    'acronym',
-    'audio',
-    'b',
-    'bdi',
-    'bdo',
-    'big',
-    'br',
-    'button',
-    'canvas',
-    'cite',
-    'code',
-    'data',
-    'datalist',
-    'del',
-    'dfn',
-    'em',
-    'embed',
-    'i',
-    /* iframe is treated as HTML blocks in markdown spec */
-    // 'iframe',
-    'img',
-    'input',
-    'ins',
-    'kbd',
-    'label',
-    'map',
-    'mark',
-    'meter',
-    'noscript',
-    'object',
-    'output',
-    'picture',
-    'progress',
-    'q',
-    'ruby',
-    's',
-    'samp',
-    'script',
-    'select',
-    'slot',
-    'small',
-    'span',
-    'strong',
-    'sub',
-    'sup',
-    'svg',
-    'template',
-    'textarea',
-    'time',
-    'u',
-    'tt',
-    'var',
-    'video',
-    'wbr',
-];

package/lib/plugins/customComponentPlugin/vueReservedTags.d.ts

@@ -1,6 +0,0 @@
-/**
- * Vue reserved tags
- *
- * @see https://vuejs.org/api/built-in-components.html
- */
-export declare const vueReservedTags: string[];

package/lib/plugins/customComponentPlugin/vueReservedTags.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.vueReservedTags = void 0;
-/**
- * Vue reserved tags
- *
- * @see https://vuejs.org/api/built-in-components.html
- */
-exports.vueReservedTags = [
-    'template',
-    'component',
-    'transition',
-    'transition-group',
-    'keep-alive',
-    'slot',
-    'teleport',
-];

package/lib/plugins/extractHeadersPlugin.d.ts

@@ -1,27 +0,0 @@
-import type { PluginWithOptions } from 'markdown-it';
-export interface ExtractHeadersPluginOptions {
-    /**
-     * Heading level that going to be extracted to the `env`
-     *
-     * Should be a subset of markdown-it-anchor's `level` option
-     * to ensure the link is existed
-     */
-    level?: number[];
-    /**
-     * A custom slugify function
-     *
-     * Should use the same slugify function with markdown-it-anchor
-     * to ensure the link is matched
-     */
-    slugify?: (str: string) => string;
-    /**
-     * A function for formatting headers
-     */
-    format?: (str: string) => string;
-}
-/**
- * Extracting markdown headers to env
- *
- * Would be used for generating sidebar nav and toc
- */
-export declare const extractHeadersPlugin: PluginWithOptions<ExtractHeadersPluginOptions>;

package/lib/plugins/extractHeadersPlugin.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractHeadersPlugin = void 0;
-const utils_1 = require("../utils");
-/**
- * Extracting markdown headers to env
- *
- * Would be used for generating sidebar nav and toc
- */
-const extractHeadersPlugin = (md, { level = [2, 3], slugify = utils_1.slugify, format, } = {}) => {
-    let headers;
-    // push the rule to the end of the chain
-    // resolve headers from the parsed tokens
-    md.core.ruler.push('resolveExtractHeaders', (state) => {
-        headers = (0, utils_1.resolveHeadersFromTokens)(state.tokens, {
-            level,
-            allowHtml: false,
-            escapeText: false,
-            slugify,
-            format,
-        });
-        return true;
-    });
-    // extract headers to env
-    const render = md.render.bind(md);
-    md.render = (src, env = {}) => {
-        const result = render(src, env);
-        env.headers = headers;
-        return result;
-    };
-};
-exports.extractHeadersPlugin = extractHeadersPlugin;

package/lib/plugins/extractTitlePlugin.d.ts

@@ -1,5 +0,0 @@
-import type { PluginSimple } from 'markdown-it';
-/**
- * Extracting markdown title to env
- */
-export declare const extractTitlePlugin: PluginSimple;

package/lib/plugins/extractTitlePlugin.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractTitlePlugin = void 0;
-const utils_1 = require("../utils");
-/**
- * Extracting markdown title to env
- */
-const extractTitlePlugin = (md) => {
-    let title;
-    // push the rule to the end of the chain
-    // resolve title from the parsed tokens
-    md.core.ruler.push('resolveExtractTitle', (state) => {
-        const tokenIdx = state.tokens.findIndex((token) => token.tag === 'h1');
-        if (tokenIdx > -1) {
-            title = (0, utils_1.resolveTitleFromToken)(state.tokens[tokenIdx + 1], {
-                escapeText: false,
-                allowHtml: false,
-            });
-        }
-        else {
-            title = '';
-        }
-        return true;
-    });
-    // extract title to env
-    const render = md.render.bind(md);
-    md.render = (src, env = {}) => {
-        const result = render(src, env);
-        env.title = env.frontmatter?.title ?? title;
-        return result;
-    };
-};
-exports.extractTitlePlugin = extractTitlePlugin;

package/lib/plugins/hoistTagsPlugin.d.ts

@@ -1,12 +0,0 @@
-import type { PluginWithOptions } from 'markdown-it';
-export interface HoistTagsPluginOptions {
-    customBlocks?: string[];
-}
-/**
- * Avoid rendering vue SFC script / style blocks
- *
- * Extract them into env
- *
- * Hoist them to vue SFC root level in following process
- */
-export declare const hoistTagsPlugin: PluginWithOptions<HoistTagsPluginOptions>;

package/lib/plugins/hoistTagsPlugin.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hoistTagsPlugin = void 0;
-/**
- * Avoid rendering vue SFC script / style blocks
- *
- * Extract them into env
- *
- * Hoist them to vue SFC root level in following process
- */
-const hoistTagsPlugin = (md, { customBlocks = [] } = {}) => {
-    // hoist <script>, <style> and other user defined tags
-    const hoistTags = Array.from(new Set(['script', 'style', ...customBlocks]));
-    const hoistTagsRegexp = new RegExp(`^<(${hoistTags.join('|')})(?=(\\s|>|$))`, 'i');
-    const rawRule = md.renderer.rules.html_block;
-    md.renderer.rules.html_block = (tokens, idx, options, env, self) => {
-        const content = tokens[idx].content;
-        const hoistedTags = env.hoistedTags || (env.hoistedTags = []);
-        // record the hoisted tags to env and do not render them
-        if (hoistTagsRegexp.test(content.trim())) {
-            hoistedTags.push(content);
-            return '';
-        }
-        return rawRule(tokens, idx, options, env, self);
-    };
-};
-exports.hoistTagsPlugin = hoistTagsPlugin;

package/lib/plugins/tocPlugin/createRenderHeaders.d.ts

@@ -1,5 +0,0 @@
-import type { MarkdownHeader } from '../../types';
-import type { TocPluginOptions } from './tocPlugin';
-declare type RenderHeadersFn = (headers: MarkdownHeader[]) => string;
-export declare const createRenderHeaders: ({ listTag, listClass, itemClass, linkTag, linkClass, }: Pick<Required<TocPluginOptions>, 'listTag' | 'listClass' | 'itemClass' | 'linkTag' | 'linkClass'>) => RenderHeadersFn;
-export {};

package/lib/plugins/tocPlugin/createRenderHeaders.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRenderHeaders = void 0;
-const shared_1 = require("@vuepress/shared");
-const createRenderHeaders = ({ listTag, listClass, itemClass, linkTag, linkClass, }) => {
-    const listTagString = (0, shared_1.htmlEscape)(listTag);
-    const listClassString = listClass ? ` class="${(0, shared_1.htmlEscape)(listClass)}"` : '';
-    const itemTagString = 'li';
-    const itemClassString = itemClass ? ` class="${(0, shared_1.htmlEscape)(itemClass)}"` : '';
-    const linkTagString = (0, shared_1.htmlEscape)(linkTag);
-    const linkClassString = linkClass ? ` class="${(0, shared_1.htmlEscape)(linkClass)}` : '';
-    const linkTo = (slug) => linkTag === 'RouterLink' ? ` to="#${slug}"` : ` href="#${slug}"`;
-    const renderHeaders = (headers) => `\
-<${listTagString}${listClassString}>\
-${headers
-        .map((header) => `\
-<${itemTagString}${itemClassString}${itemClassString}>\
-<${linkTagString}${linkClassString}${linkTo(header.slug)}>\
-${header.title}\
-</${linkTagString}>\
-${header.children.length > 0 ? renderHeaders(header.children) : ''}\
-</${itemTagString}>\
-`)
-        .join('')}\
-</${listTagString}>`;
-    return renderHeaders;
-};
-exports.createRenderHeaders = createRenderHeaders;

package/lib/plugins/tocPlugin/createTocBlockRule.d.ts

@@ -1,11 +0,0 @@
-import type { RuleBlock } from 'markdown-it/lib/parser_block';
-import type { TocPluginOptions } from './tocPlugin';
-/**
- * Forked and modified from markdown-it-toc-done-right
- *
- * - remove the `inlineOptions` support
- * - use markdown-it default renderer to render token whenever possible
- *
- * @see https://github.com/nagaozen/markdown-it-toc-done-right
- */
-export declare const createTocBlockRule: ({ pattern, containerTag, containerClass, }: Pick<Required<TocPluginOptions>, 'pattern' | 'containerTag' | 'containerClass'>) => RuleBlock;

package/lib/plugins/tocPlugin/createTocBlockRule.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTocBlockRule = void 0;
-/**
- * Forked and modified from markdown-it-toc-done-right
- *
- * - remove the `inlineOptions` support
- * - use markdown-it default renderer to render token whenever possible
- *
- * @see https://github.com/nagaozen/markdown-it-toc-done-right
- */
-const createTocBlockRule = ({ pattern, containerTag, containerClass, }) => {
-    return (state, startLine, endLine, silent) => {
-        // if it's indented more than 3 spaces, it should be a code block
-        if (state.sCount[startLine] - state.blkIndent >= 4) {
-            return false;
-        }
-        const pos = state.bMarks[startLine] + state.tShift[startLine];
-        const max = state.eMarks[startLine];
-        // use whitespace as a line tokenizer and extract the first token
-        // to test against the placeholder anchored pattern, rejecting if false
-        const lineFirstToken = state.src.slice(pos, max).split(' ')[0];
-        if (!pattern.test(lineFirstToken))
-            return false;
-        if (silent)
-            return true;
-        state.line = startLine + 1;
-        // generate toc_open token
-        // will be rendered by markdown-it default renderer
-        const tokenOpen = state.push('toc_open', containerTag, 1);
-        tokenOpen.markup = '';
-        tokenOpen.map = [startLine, state.line];
-        if (containerClass) {
-            tokenOpen.attrSet('class', containerClass);
-        }
-        // generate toc_body token
-        // will be rendered by our custom renderer
-        const tokenBody = state.push('toc_body', '', 0);
-        tokenBody.markup = lineFirstToken;
-        tokenBody.map = [startLine, state.line];
-        tokenBody.hidden = true;
-        // generate toc_close token
-        // will be rendered by markdown-it default renderer
-        const tokenClose = state.push('toc_close', containerTag, -1);
-        tokenClose.markup = '';
-        tokenBody.map = [startLine, state.line];
-        return true;
-    };
-};
-exports.createTocBlockRule = createTocBlockRule;

package/lib/plugins/tocPlugin/index.d.ts

@@ -1,3 +0,0 @@
-export * from './createRenderHeaders';
-export * from './createTocBlockRule';
-export * from './tocPlugin';

package/lib/plugins/tocPlugin/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./createRenderHeaders"), exports);
-__exportStar(require("./createTocBlockRule"), exports);
-__exportStar(require("./tocPlugin"), exports);

package/lib/plugins/tocPlugin/tocPlugin.d.ts

@@ -1,65 +0,0 @@
-import type { PluginWithOptions } from 'markdown-it';
-export interface TocPluginOptions {
-    /**
-     * The pattern serving as the TOC placeholder in your markdown
-     */
-    pattern?: RegExp;
-    /**
-     * A custom slugify function
-     *
-     * Should use the same slugify function with markdown-it-anchor
-     * to ensure the link is matched
-     */
-    slugify?: (str: string) => string;
-    /**
-     * A function for formatting headers
-     */
-    format?: (str: string) => string;
-    /**
-     * Heading level that going to be extracted to the `env`
-     *
-     * Should be a subset of markdown-it-anchor's `level` option
-     * to ensure the link is existed
-     */
-    level?: number[];
-    /**
-     * HTML tag of container
-     */
-    containerTag?: string;
-    /**
-     * The class for container
-     */
-    containerClass?: string;
-    /**
-     * HTML tag of list
-     */
-    listTag?: 'ul' | 'ol';
-    /**
-     * The class for list
-     */
-    listClass?: string;
-    /**
-     * The class for the <li> tag
-     */
-    itemClass?: string;
-    /**
-     * The tag for the link inside <li>
-     */
-    linkTag?: 'a' | 'RouterLink';
-    /**
-     * The class for the link tag inside <li>
-     */
-    linkClass?: string;
-}
-/**
- * Generate table of contents
- *
- * Forked and modified from markdown-it-toc-done-right:
- *
- * - Allows `html_inline` tags in headings to support vue components
- * - Allows render `<RouterLink>` instead of `<a>` for links
- * - Code refactor and optimizations
- *
- * @see https://github.com/nagaozen/markdown-it-toc-done-right
- */
-export declare const tocPlugin: PluginWithOptions<TocPluginOptions>;

package/lib/plugins/tocPlugin/tocPlugin.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tocPlugin = void 0;
-const utils_1 = require("../../utils");
-const createRenderHeaders_1 = require("./createRenderHeaders");
-const createTocBlockRule_1 = require("./createTocBlockRule");
-/**
- * Generate table of contents
- *
- * Forked and modified from markdown-it-toc-done-right:
- *
- * - Allows `html_inline` tags in headings to support vue components
- * - Allows render `<RouterLink>` instead of `<a>` for links
- * - Code refactor and optimizations
- *
- * @see https://github.com/nagaozen/markdown-it-toc-done-right
- */
-const tocPlugin = (md, { pattern = /^\[\[toc\]\]$/i, slugify = utils_1.slugify, format, level = [2, 3], containerTag = 'nav', containerClass = 'table-of-contents', listTag = 'ul', listClass = '', itemClass = '', linkTag = 'a', linkClass = '', } = {}) => {
-    let headers;
-    // push the rule to the end of the chain
-    // resolve headers from the parsed tokens
-    md.core.ruler.push('resolveTocHeaders', (state) => {
-        headers = (0, utils_1.resolveHeadersFromTokens)(state.tokens, {
-            level,
-            allowHtml: true,
-            escapeText: true,
-            slugify,
-            format,
-        });
-        return true;
-    });
-    // add toc syntax as a block rule
-    md.block.ruler.before('heading', 'toc', (0, createTocBlockRule_1.createTocBlockRule)({
-        pattern,
-        containerTag,
-        containerClass,
-    }), {
-        alt: ['paragraph', 'reference', 'blockquote'],
-    });
-    const renderHeaders = (0, createRenderHeaders_1.createRenderHeaders)({
-        listTag,
-        listClass,
-        itemClass,
-        linkTag,
-        linkClass,
-    });
-    // custom toc_body render rule
-    md.renderer.rules.toc_body = () => {
-        /* istanbul ignore if */
-        if (!headers) {
-            return '';
-        }
-        return renderHeaders(headers);
-    };
-};
-exports.tocPlugin = tocPlugin;

package/lib/utils/index.d.ts

@@ -1,3 +0,0 @@
-export * from './resolveHeadersFromTokens';
-export * from './resolveTitleFromToken';
-export * from './slugify';

package/lib/utils/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./resolveHeadersFromTokens"), exports);
-__exportStar(require("./resolveTitleFromToken"), exports);
-__exportStar(require("./slugify"), exports);

package/lib/utils/resolveHeadersFromTokens.d.ts

@@ -1,12 +0,0 @@
-import type * as Token from 'markdown-it/lib/token';
-import type { MarkdownHeader } from '../types';
-/**
- * Resolve headers from markdown-it tokens
- */
-export declare const resolveHeadersFromTokens: (tokens: Token[], { level, allowHtml, escapeText, slugify, format, }: {
-    level: number[];
-    allowHtml: boolean;
-    escapeText: boolean;
-    slugify: (str: string) => string;
-    format?: ((str: string) => string) | undefined;
-}) => MarkdownHeader[];

package/lib/utils/resolveHeadersFromTokens.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveHeadersFromTokens = void 0;
-const shared_1 = require("@vuepress/shared");
-const resolveTitleFromToken_1 = require("./resolveTitleFromToken");
-/**
- * Resolve headers from markdown-it tokens
- */
-const resolveHeadersFromTokens = (tokens, { level, allowHtml, escapeText, slugify, format, }) => {
-    // store the result of headers
-    const headers = [];
-    // a temp headers stack for generating the headers tree
-    const stack = [];
-    // push a header to the headers tree
-    const push = (header) => {
-        while (stack.length !== 0 && header.level <= stack[0].level) {
-            stack.shift();
-        }
-        if (stack.length === 0) {
-            headers.push(header);
-            stack.push(header);
-        }
-        else {
-            stack[0].children.push(header);
-            stack.unshift(header);
-        }
-    };
-    tokens.forEach((_, idx) => {
-        const token = tokens[idx];
-        // if the token type does not match, skip
-        if (token?.type !== 'heading_open') {
-            return;
-        }
-        // get the level from the tag, h1 -> 1
-        const headerLevel = Number.parseInt(token.tag.slice(1), 10);
-        // if the level should not be extracted, skip
-        if (!level.includes(headerLevel)) {
-            return;
-        }
-        // the next token of 'heading_open' contains the heading content
-        const nextToken = tokens[idx + 1];
-        // if the next token does not exist, skip
-        if (!nextToken) {
-            return;
-        }
-        const title = (0, resolveTitleFromToken_1.resolveTitleFromToken)(nextToken, {
-            allowHtml,
-            escapeText,
-        });
-        // the id of the heading anchor is the slugify result of markdown-it-anchor
-        // if the id does not exist, slugify the title ourselves
-        const slug = token.attrGet('id') ?? slugify(title);
-        // push the header to tree
-        push({
-            level: headerLevel,
-            title: (0, shared_1.isFunction)(format) ? format(title) : title,
-            slug,
-            children: [],
-        });
-    });
-    return headers;
-};
-exports.resolveHeadersFromTokens = resolveHeadersFromTokens;

package/lib/utils/resolveTitleFromToken.d.ts

@@ -1,10 +0,0 @@
-import type * as Token from 'markdown-it/lib/token';
-/**
- * Resolve header title from markdown-it token
- *
- * Typically using the next token of `heading_open` token
- */
-export declare const resolveTitleFromToken: (token: Token, { allowHtml, escapeText, }: {
-    allowHtml: boolean;
-    escapeText: boolean;
-}) => string;

package/lib/utils/resolveTitleFromToken.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveTitleFromToken = void 0;
-const shared_1 = require("@vuepress/shared");
-/**
- * Resolve header title from markdown-it token
- *
- * Typically using the next token of `heading_open` token
- */
-const resolveTitleFromToken = (token, { allowHtml, escapeText, }) => {
-    // children of the token contains the parsed result of the heading title
-    const children = token.children ?? [];
-    // type of tokens to be included in the heading title
-    const titleTokenTypes = ['text', 'emoji', 'code_inline'];
-    // include 'html_inline' or not
-    if (allowHtml) {
-        titleTokenTypes.push('html_inline');
-    }
-    // filter the token type to be included in the title
-    const titleTokens = children.filter((item) => titleTokenTypes.includes(item.type) &&
-        // filter permalink symbol that generated by markdown-it-anchor
-        !item.meta?.isPermalinkSymbol);
-    // get title from tokens
-    return titleTokens
-        .reduce((result, item) => {
-        if (escapeText) {
-            // escape the content of 'code_inline' and 'text'
-            if (item.type === 'code_inline' || item.type === 'text') {
-                return `${result}${(0, shared_1.htmlEscape)(item.content)}`;
-            }
-        }
-        // keep the content of 'emoji' and 'html_inline'
-        return `${result}${item.content}`;
-    }, '')
-        .trim();
-};
-exports.resolveTitleFromToken = resolveTitleFromToken;

package/lib/utils/slugify.d.ts

@@ -1 +0,0 @@
-export declare const slugify: (str: string) => string;

package/lib/utils/slugify.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.slugify = void 0;
-// eslint-disable-next-line no-control-regex
-const rControl = /[\u0000-\u001f]/g;
-const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
-const rCombining = /[\u0300-\u036F]/g;
-const slugify = (str) => str
-    .normalize('NFKD')
-    // Remove accents
-    .replace(rCombining, '')
-    // Remove control characters
-    .replace(rControl, '')
-    // Replace special characters
-    .replace(rSpecial, '-')
-    // Remove continuos separators
-    .replace(/-{2,}/g, '-')
-    // Remove prefixing and trailing separators
-    .replace(/^-+|-+$/g, '')
-    // ensure it doesn't start with a number (#121)
-    .replace(/^(\d)/, '_$1')
-    // lowercase
-    .toLowerCase();
-exports.slugify = slugify;