@vuepress/markdown 2.0.0-rc.3 → 2.0.0-rc.30

package/README.md

@@ -5,7 +5,7 @@
 
 ## Documentation
 
-https://v2.vuepress.vuejs.org
+https://vuepress.vuejs.org
 
 ## License
 

package/dist/index.d.ts

@@ -1,132 +1,129 @@
-import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
-export { MarkdownSfcBlocks, SfcPluginOptions, sfcPlugin } from '@mdit-vue/plugin-sfc';
-import { MarkdownItEnv } from '@mdit-vue/types';
-import { PageHeader, PageFrontmatter } from '@vuepress/shared';
-import MarkdownIt, { PluginWithOptions } from 'markdown-it';
-import { FrontmatterPluginOptions } from '@mdit-vue/plugin-frontmatter';
-export { FrontmatterPluginOptions, frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
-import { HeadersPluginOptions } from '@mdit-vue/plugin-headers';
-export { HeadersPluginOptions, headersPlugin } from '@mdit-vue/plugin-headers';
-import { TocPluginOptions } from '@mdit-vue/plugin-toc';
-export { TocPluginOptions, tocPlugin } from '@mdit-vue/plugin-toc';
-import anchorPlugin from 'markdown-it-anchor';
-export { default as anchorPlugin } from 'markdown-it-anchor';
-import { Options } from 'markdown-it-emoji';
-export { full as emojiPlugin } from 'markdown-it-emoji';
-export { ComponentPluginOptions, componentPlugin } from '@mdit-vue/plugin-component';
-export { titlePlugin } from '@mdit-vue/plugin-title';
+import MarkdownIt, { Options, PluginWithOptions } from "markdown-it";
+import { ComponentPluginOptions, componentPlugin } from "@mdit-vue/plugin-component";
+import { FrontmatterPluginOptions, frontmatterPlugin } from "@mdit-vue/plugin-frontmatter";
+import { HeadersPluginOptions, headersPlugin } from "@mdit-vue/plugin-headers";
+import { MarkdownSfcBlocks, SfcPluginOptions, sfcPlugin } from "@mdit-vue/plugin-sfc";
+import { titlePlugin } from "@mdit-vue/plugin-title";
+import { TocPluginOptions, tocPlugin } from "@mdit-vue/plugin-toc";
+import anchorPlugin from "markdown-it-anchor";
+import { Options as Options$1, full as emojiPlugin } from "markdown-it-emoji";
+import { PageFrontmatter, PageHeader } from "@vuepress/shared";
+import { MarkdownItEnv } from "@mdit-vue/types";
 
+//#region src/plugins/anchorPlugin.d.ts
 type AnchorPluginOptions = anchorPlugin.AnchorOptions;
-
+//#endregion
+//#region src/plugins/assetsPlugin/assetsPlugin.d.ts
 interface AssetsPluginOptions {
-    /**
-     * Whether to prepend base to absolute path
-     */
-    absolutePathPrependBase?: boolean;
-    /**
-     * Prefix to add to relative assets links
-     */
-    relativePathPrefix?: string;
+  /**
+   * Whether to prepend base to absolute path
+   */
+  absolutePathPrependBase?: boolean;
+  /**
+   * Use aliases for non-strict relative paths.
+   *
+   * This is a path that does not start
+   * with `./` or `../` or `/` or `<protocol header>`:
+   * `<img src="path1/path2.png" />`
+   *
+   * - If the option is `true`. `path1` is regarded as an alias.
+   * - If the option is `false`. It is regarded as a relative path.
+   * - If the option is `"@-prefix"`.
+   *   If the path starts with `@`, `path1` is regarded as an alias;
+   *   Otherwise, it is regarded as a relative path.
+   *
+   * @default true
+   */
+  aliasSupport?: boolean | '@-prefix';
 }
 /**
  * Plugin to handle assets links
  */
 declare const assetsPlugin: PluginWithOptions<AssetsPluginOptions>;
-
-interface CodePluginOptions {
-    /**
-     * Enable highlight lines or not
-     */
-    highlightLines?: boolean;
-    /**
-     * Enable line numbers or not
-     *
-     * - A `boolean` value is to enable line numbers or not.
-     * - A `number` value is the minimum number of lines to enable line numbers
-     */
-    lineNumbers?: boolean | number;
-    /**
-     * Wrap the `<pre>` tag with an extra `<div>` or not. Do not disable it unless you
-     * understand what's it for
-     *
-     * - Required for `highlightLines`
-     * - Required for `lineNumbers`
-     * - Required for title display of default theme
-     */
-    preWrapper?: boolean;
-    /**
-     * Add `v-pre` directive or not
-     */
-    vPre?: {
-        /**
-         * Add `v-pre` directive to `<pre>` tag of code block or not
-         */
-        block?: boolean;
-        /**
-         * Add `v-pre` directive to `<code>` tag of inline code or not
-         */
-        inline?: boolean;
-    };
-}
-/**
- * Code plugin
- */
-declare const codePlugin: PluginWithOptions<CodePluginOptions>;
-
-type EmojiPluginOptions = Options;
-
+//#endregion
+//#region src/plugins/emojiPlugin.d.ts
+type EmojiPluginOptions = Options$1;
+//#endregion
+//#region src/plugins/importCodePlugin/importCodePlugin.d.ts
 interface ImportCodePluginOptions {
-    /**
-     * A function to handle the import path
-     */
-    handleImportPath?: (str: string) => string;
+  /**
+   * A function to handle the import path
+   */
+  handleImportPath?: (str: string) => string;
 }
 declare const importCodePlugin: PluginWithOptions<ImportCodePluginOptions>;
-
+//#endregion
+//#region src/plugins/linksPlugin/linksPlugin.d.ts
 interface LinksPluginOptions {
-    /**
-     * Tag for internal links
-     *
-     * @default 'VPLink'
-     */
-    internalTag?: 'a' | 'VPLink' | 'RouterLink';
-    /**
-     * Additional attributes for external links
-     *
-     * @default
-     * ```js
-     * ({
-     *   target: '_blank',
-     *   rel: 'noopener noreferrer',
-     * })
-     * ```
-     */
-    externalAttrs?: Record<string, string>;
+  /**
+   * Additional attributes for external links
+   *
+   * @default
+   * ```js
+   * ({
+   *   target: '_blank',
+   *   rel: 'noopener noreferrer',
+   * })
+   * ```
+   */
+  externalAttrs?: Record<string, string>;
+  /**
+   * Tag for internal links
+   *
+   * @default 'RouteLink'
+   */
+  internalTag?: 'a' | 'RouteLink' | 'RouterLink';
+  /**
+   * Method to check if a link is external
+   *
+   * @default import { isLinkExternal } from '@vuepress/shared'
+   */
+  isExternal?: (href: string, env: MarkdownEnv) => boolean;
 }
 /**
  * Process links in markdown file
  *
- * - internal links: convert them into `<VPLink>`
- * - external links: add extra attrs and external icon
+ * - internal links: convert `<a>` tag into internalTag
+ * - external links: add extra attrs
  */
 declare const linksPlugin: PluginWithOptions<LinksPluginOptions>;
-
+//#endregion
+//#region src/plugins/vPrePlugin/vPrePlugin.d.ts
+interface VPrePluginOptions {
+  /**
+   * Add `v-pre` directive to `<pre>` tag of code block or not
+   */
+  block?: boolean;
+  /**
+   * Add `v-pre` directive to `<code>` tag of inline code or not
+   */
+  inline?: boolean;
+}
+/**
+ * v-pre plugin
+ */
+declare const vPrePlugin: PluginWithOptions<VPrePluginOptions>;
+//#endregion
+//#region src/types.d.ts
 type Markdown = MarkdownIt;
-
-interface MarkdownOptions extends MarkdownIt.Options {
-    anchor?: false | AnchorPluginOptions;
-    assets?: false | AssetsPluginOptions;
-    code?: false | CodePluginOptions;
-    component?: false;
-    emoji?: false | EmojiPluginOptions;
-    frontmatter?: false | FrontmatterPluginOptions;
-    headers?: false | HeadersPluginOptions;
-    title?: false;
-    importCode?: false | ImportCodePluginOptions;
-    links?: false | LinksPluginOptions;
-    sfc?: false | SfcPluginOptions;
-    slugify?: MarkdownSlugifyFunction;
-    toc?: false | TocPluginOptions;
+interface MarkdownOptions extends Options {
+  anchor?: AnchorPluginOptions | false;
+  assets?: AssetsPluginOptions | false;
+  component?: false;
+  emoji?: EmojiPluginOptions | false;
+  frontmatter?: FrontmatterPluginOptions | false;
+  headers?: HeadersPluginOptions | false;
+  title?: false;
+  importCode?: ImportCodePluginOptions | false;
+  links?: LinksPluginOptions | false;
+  sfc?: SfcPluginOptions | false;
+  slugify?: MarkdownSlugifyFunction;
+  toc?: TocPluginOptions | false;
+  vPre?: VPrePluginOptions | false;
+  /**
+   * @deprecated This feature has been removed. Please use `@vuepress/plugin-prismjs` or `@vuepress/plugin-shiki` instead.
+   */
+  code?: never;
 }
 /**
  * Headers in markdown file
@@ -138,9 +135,9 @@ type MarkdownHeader = PageHeader;
  * Used for file existence check
  */
 interface MarkdownLink {
-    raw: string;
-    relative: string;
-    absolute: string;
+  raw: string;
+  relative: string;
+  absolute: string | null;
 }
 /**
  * The `env` object to be passed to markdown-it render function
@@ -150,39 +147,56 @@ interface MarkdownLink {
  * Output some resources from the markdown file
  */
 interface MarkdownEnv extends MarkdownItEnv {
-    /**
-     * 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;
-    /**
-     * Imported file that extracted by importCodePlugin
-     */
-    importedFiles?: string[];
-    /**
-     * Links that extracted by linksPlugin
-     */
-    links?: MarkdownLink[];
+  /**
+   * 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;
+  /**
+   * Imported file that extracted by importCodePlugin
+   */
+  importedFiles?: string[];
+  /**
+   * Links that extracted by linksPlugin
+   */
+  links?: MarkdownLink[];
 }
 /**
  * Type of `slugify` function
  */
 type MarkdownSlugifyFunction = (str: string) => string;
-
+//#endregion
+//#region src/markdown.d.ts
 /**
  * Create vuepress customized markdown-it instance
  */
-declare const createMarkdown: ({ anchor, assets, code, component, emoji, frontmatter, headers, title, importCode, links, sfc, slugify, toc, ...markdownItOptions }?: MarkdownOptions) => Markdown;
-
-export { type AnchorPluginOptions, type AssetsPluginOptions, type CodePluginOptions, type EmojiPluginOptions, type ImportCodePluginOptions, type LinksPluginOptions, type Markdown, type MarkdownEnv, type MarkdownHeader, type MarkdownLink, type MarkdownOptions, type MarkdownSlugifyFunction, assetsPlugin, codePlugin, createMarkdown, importCodePlugin, linksPlugin };
+declare const createMarkdown: ({
+  anchor,
+  assets,
+  code,
+  vPre,
+  component,
+  emoji,
+  frontmatter,
+  headers,
+  title,
+  importCode,
+  links,
+  sfc,
+  slugify,
+  toc,
+  ...markdownItOptions
+}?: MarkdownOptions) => Markdown;
+//#endregion
+export { type AnchorPluginOptions, type AssetsPluginOptions, type ComponentPluginOptions, type EmojiPluginOptions, type FrontmatterPluginOptions, type HeadersPluginOptions, type ImportCodePluginOptions, type LinksPluginOptions, Markdown, MarkdownEnv, MarkdownHeader, MarkdownLink, MarkdownOptions, type MarkdownSfcBlocks, MarkdownSlugifyFunction, type SfcPluginOptions, type TocPluginOptions, type VPrePluginOptions, anchorPlugin, assetsPlugin, componentPlugin, createMarkdown, emojiPlugin, frontmatterPlugin, headersPlugin, importCodePlugin, linksPlugin, sfcPlugin, titlePlugin, tocPlugin, vPrePlugin };