@vuepress/markdown 2.0.0-beta.48 → 2.0.0-beta.50-pre

package/lib/types.d.ts

@@ -1,81 +0,0 @@
-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';
-export declare type Markdown = MarkdownIt;
-export interface MarkdownOptions extends MarkdownIt.Options {
-    anchor?: false | AnchorPluginOptions;
-    assets?: false | AssetsPluginOptions;
-    code?: false | CodePluginOptions;
-    customComponent?: false;
-    emoji?: false | EmojiPluginOptions;
-    extractHeaders?: false | ExtractHeadersPluginOptions;
-    extractTitle?: false;
-    hoistTags?: false | HoistTagsPluginOptions;
-    importCode?: false | ImportCodePluginOptions;
-    links?: false | LinksPluginOptions;
-    slugify?: MarkdownSlugifyFunction;
-    toc?: false | TocPluginOptions;
-}
-/**
- * Headers in markdown file
- */
-export declare type MarkdownHeader = PageHeader;
-/**
- * Internal links in markdown file
- *
- * Used for file existence check
- */
-export interface MarkdownLink {
-    raw: string;
-    relative: string;
-    absolute: string;
-}
-/**
- * The `env` object to be passed to markdown-it render function
- *
- * Input some meta data for markdown file parsing and rendering
- *
- * Output some resources from the markdown file
- */
-export interface MarkdownEnv {
-    /**
-     * Base / publicPath of current site
-     */
-    base?: string;
-    /**
-     * Absolute file path of the markdown file
-     */
-    filePath?: string | null;
-    /**
-     * Relative file path of the markdown file
-     */
-    filePathRelative?: string | null;
-    /**
-     * 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
-     */
-    importedFiles?: string[];
-    /**
-     * 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/lib/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/index.d.ts

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

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("./vuepressSlugify"), 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/vuepressSlugify.d.ts

@@ -1,5 +0,0 @@
-import type { MarkdownSlugifyFunction } from '../types';
-/**
- * Default slugify function of vuepress
- */
-export declare const vuepressSlugify: MarkdownSlugifyFunction;

package/lib/utils/vuepressSlugify.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.vuepressSlugify = void 0;
-// eslint-disable-next-line no-control-regex
-const rControl = /[\u0000-\u001f]/g;
-const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
-const rCombining = /[\u0300-\u036F]/g;
-/**
- * Default slugify function of vuepress
- */
-const vuepressSlugify = (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.vuepressSlugify = vuepressSlugify;