@mdit-vue/plugin-headers 2.1.4 → 3.0.1

package/dist/index.d.ts

@@ -1,55 +1,56 @@
-import { PluginWithOptions } from 'markdown-it';
-import { MarkdownItHeader } from '@mdit-vue/types';
-export { MarkdownItHeader } from '@mdit-vue/types';
+import { PluginWithOptions } from "markdown-it";
+import { MarkdownItHeader } from "@mdit-vue/types";
+
+//#region src/types.d.ts
 
 /**
  * Options of @mdit-vue/plugin-headers
  */
 interface HeadersPluginOptions {
-    /**
-     * A custom slugification 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 header title
-     */
-    format?: (str: string) => string;
-    /**
-     * Heading level that going to be extracted
-     *
-     * Should be a subset of markdown-it-anchor's `level` option
-     * to ensure the slug is existed
-     *
-     * @default [2,3]
-     */
-    level?: number[];
-    /**
-     * Should allow headers inside nested blocks or not
-     *
-     * If set to `true`, headers inside blockquote, list, etc. would also be extracted.
-     *
-     * @default false
-     */
-    shouldAllowNested?: boolean;
+  /**
+   * A custom slugification 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 header title
+   */
+  format?: (str: string) => string;
+  /**
+   * Heading level that going to be extracted
+   *
+   * Should be a subset of markdown-it-anchor's `level` option
+   * to ensure the slug is existed
+   *
+   * @default [2,3]
+   */
+  level?: number[];
+  /**
+   * Should allow headers inside nested blocks or not
+   *
+   * If set to `true`, headers inside blockquote, list, etc. would also be extracted.
+   *
+   * @default false
+   */
+  shouldAllowNested?: boolean;
 }
 declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        /**
-         * The headers that extracted by `@mdit-vue/plugin-headers`
-         */
-        headers?: MarkdownItHeader[];
-    }
+  interface MarkdownItEnv {
+    /**
+     * The headers that extracted by `@mdit-vue/plugin-headers`
+     */
+    headers?: MarkdownItHeader[];
+  }
 }
-
+//#endregion
+//#region src/headers-plugin.d.ts
 /**
  * Get markdown headers info
  *
  * Extract them into env
  */
 declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>;
-
-export { headersPlugin };
-export type { HeadersPluginOptions };
+//#endregion
+export { HeadersPluginOptions, type MarkdownItHeader, headersPlugin };

package/dist/index.js

@@ -0,0 +1,25 @@
+import { resolveHeadersFromTokens, slugify } from "@mdit-vue/shared";
+
+//#region src/headers-plugin.ts
+/**
+* Get markdown headers info
+*
+* Extract them into env
+*/
+const headersPlugin = (md, { level = [2, 3], shouldAllowNested = false, slugify: slugify$1 = slugify, format } = {}) => {
+	const render = md.renderer.render.bind(md.renderer);
+	md.renderer.render = (tokens, options, env) => {
+		env.headers = resolveHeadersFromTokens(tokens, {
+			level,
+			shouldAllowHtml: false,
+			shouldAllowNested,
+			shouldEscapeText: false,
+			slugify: slugify$1,
+			format
+		});
+		return render(tokens, options, env);
+	};
+};
+
+//#endregion
+export { headersPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-headers",
-  "version": "2.1.4",
+  "version": "3.0.1",
   "description": "A markdown-it plugin to get markdown headers",
   "keywords": [
     "markdown-it",
@@ -21,38 +21,35 @@
   "author": "meteorlxy <meteor.lxy@foxmail.com>",
   "type": "module",
   "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "./dist"
   ],
   "scripts": {
-    "build": "unbuild",
+    "build": "tsdown",
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/shared": "2.1.4",
-    "@mdit-vue/types": "2.1.4",
+    "@mdit-vue/shared": "3.0.1",
+    "@mdit-vue/types": "3.0.1",
     "@types/markdown-it": "^14.1.2",
     "markdown-it": "^14.1.0"
   },
   "devDependencies": {
-    "markdown-it-anchor": "^9.2.0"
+    "markdown-it-anchor": "^9.2.0",
+    "tsdown": "^0.14.0",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "01a6daa37fff48ea3992becfd4ba8c0f97a605ad"
+  "gitHead": "cdffe386ef7b897f1bf878ce20e38bdd07908fb1"
 }

package/dist/index.cjs

@@ -1,25 +0,0 @@
-'use strict';
-
-const shared = require('@mdit-vue/shared');
-
-const headersPlugin = (md, {
-  level = [2, 3],
-  shouldAllowNested = false,
-  slugify = shared.slugify,
-  format
-} = {}) => {
-  const render = md.renderer.render.bind(md.renderer);
-  md.renderer.render = (tokens, options, env) => {
-    env.headers = shared.resolveHeadersFromTokens(tokens, {
-      level,
-      shouldAllowHtml: false,
-      shouldAllowNested,
-      shouldEscapeText: false,
-      slugify,
-      format
-    });
-    return render(tokens, options, env);
-  };
-};
-
-exports.headersPlugin = headersPlugin;

package/dist/index.d.cts

@@ -1,55 +0,0 @@
-import { PluginWithOptions } from 'markdown-it';
-import { MarkdownItHeader } from '@mdit-vue/types';
-export { MarkdownItHeader } from '@mdit-vue/types';
-
-/**
- * Options of @mdit-vue/plugin-headers
- */
-interface HeadersPluginOptions {
-    /**
-     * A custom slugification 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 header title
-     */
-    format?: (str: string) => string;
-    /**
-     * Heading level that going to be extracted
-     *
-     * Should be a subset of markdown-it-anchor's `level` option
-     * to ensure the slug is existed
-     *
-     * @default [2,3]
-     */
-    level?: number[];
-    /**
-     * Should allow headers inside nested blocks or not
-     *
-     * If set to `true`, headers inside blockquote, list, etc. would also be extracted.
-     *
-     * @default false
-     */
-    shouldAllowNested?: boolean;
-}
-declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        /**
-         * The headers that extracted by `@mdit-vue/plugin-headers`
-         */
-        headers?: MarkdownItHeader[];
-    }
-}
-
-/**
- * Get markdown headers info
- *
- * Extract them into env
- */
-declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>;
-
-export { headersPlugin };
-export type { HeadersPluginOptions };

package/dist/index.d.mts

@@ -1,55 +0,0 @@
-import { PluginWithOptions } from 'markdown-it';
-import { MarkdownItHeader } from '@mdit-vue/types';
-export { MarkdownItHeader } from '@mdit-vue/types';
-
-/**
- * Options of @mdit-vue/plugin-headers
- */
-interface HeadersPluginOptions {
-    /**
-     * A custom slugification 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 header title
-     */
-    format?: (str: string) => string;
-    /**
-     * Heading level that going to be extracted
-     *
-     * Should be a subset of markdown-it-anchor's `level` option
-     * to ensure the slug is existed
-     *
-     * @default [2,3]
-     */
-    level?: number[];
-    /**
-     * Should allow headers inside nested blocks or not
-     *
-     * If set to `true`, headers inside blockquote, list, etc. would also be extracted.
-     *
-     * @default false
-     */
-    shouldAllowNested?: boolean;
-}
-declare module '@mdit-vue/types' {
-    interface MarkdownItEnv {
-        /**
-         * The headers that extracted by `@mdit-vue/plugin-headers`
-         */
-        headers?: MarkdownItHeader[];
-    }
-}
-
-/**
- * Get markdown headers info
- *
- * Extract them into env
- */
-declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>;
-
-export { headersPlugin };
-export type { HeadersPluginOptions };

package/dist/index.mjs

@@ -1,23 +0,0 @@
-import { resolveHeadersFromTokens, slugify } from '@mdit-vue/shared';
-
-const headersPlugin = (md, {
-  level = [2, 3],
-  shouldAllowNested = false,
-  slugify: slugify$1 = slugify,
-  format
-} = {}) => {
-  const render = md.renderer.render.bind(md.renderer);
-  md.renderer.render = (tokens, options, env) => {
-    env.headers = resolveHeadersFromTokens(tokens, {
-      level,
-      shouldAllowHtml: false,
-      shouldAllowNested,
-      shouldEscapeText: false,
-      slugify: slugify$1,
-      format
-    });
-    return render(tokens, options, env);
-  };
-};
-
-export { headersPlugin };