@mdit-vue/plugin-headers 0.12.0 → 0.12.1

package/dist/index.d.cts

@@ -0,0 +1,54 @@
+import MarkdownIt 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: MarkdownIt.PluginWithOptions<HeadersPluginOptions>;
+
+export { type HeadersPluginOptions, headersPlugin };

package/dist/index.d.mts

@@ -0,0 +1,54 @@
+import MarkdownIt 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: MarkdownIt.PluginWithOptions<HeadersPluginOptions>;
+
+export { type HeadersPluginOptions, headersPlugin };

package/dist/index.d.ts

@@ -51,4 +51,4 @@ declare module '@mdit-vue/types' {
  */
 declare const headersPlugin: MarkdownIt.PluginWithOptions<HeadersPluginOptions>;
 
-export { HeadersPluginOptions, headersPlugin };
+export { type HeadersPluginOptions, headersPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-headers",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "A markdown-it plugin to get markdown headers",
   "keywords": [
     "markdown-it",
@@ -38,16 +38,16 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/shared": "0.12.0",
+    "@mdit-vue/shared": "0.12.1",
     "@mdit-vue/types": "0.12.0",
-    "@types/markdown-it": "^12.2.3",
+    "@types/markdown-it": "^13.0.0",
     "markdown-it": "^13.0.1"
   },
   "devDependencies": {
-    "markdown-it-anchor": "^8.6.6"
+    "markdown-it-anchor": "^8.6.7"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "986b6023d3460cadefd409cd5d4b6445af3a05bd"
+  "gitHead": "198a71b2e4175a92843609a63d2a848bddb71740"
 }