@md-plugins/md-plugin-headers 0.1.0-alpha.9 → 0.1.0-beta.0

package/README.md

@@ -17,12 +17,12 @@ A **Markdown-It** plugin that extracts and processes headers from Markdown conte
 Install the plugin via your preferred package manager:
 
 ```bash
-# With npm:
-npm install @md-plugins/md-plugin-headers
-# Or with Yarn:
-yarn add @md-plugins/md-plugin-headers
-# Or with pnpm:
+# with pnpm:
 pnpm add @md-plugins/md-plugin-headers
+# with Yarn:
+yarn add @md-plugins/md-plugin-headers
+# with npm:
+npm install @md-plugins/md-plugin-headers
 ```
 
 ## Usage
@@ -148,6 +148,10 @@ md.use(headersPlugin, {
 pnpm test
 ```
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/headers/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -32,6 +32,22 @@ interface HeadersPluginOptions {
      * @default false
      */
     shouldAllowNested?: boolean;
+    /**
+     * Should allow API headers
+     *
+     * If set to `true`, headers for `<MarkdownAPI>` title would also be extracted.
+     *
+     * @default true
+     */
+    shouldAllowApi?: boolean;
+    /**
+     * Should allow Example headers
+     *
+     * If set to `true`, headers for `<MarkdownExample>` title would also be extracted.
+     *
+     * @default true
+     */
+    shouldAllowExample?: boolean;
 }
 interface TocItem {
     id: string;
@@ -50,4 +66,5 @@ declare module '@md-plugins/shared' {
 
 declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>;
 
-export { type HeadersPluginOptions, type TocItem, headersPlugin };
+export { headersPlugin };
+export type { HeadersPluginOptions, TocItem };

package/dist/index.d.ts

@@ -32,6 +32,22 @@ interface HeadersPluginOptions {
      * @default false
      */
     shouldAllowNested?: boolean;
+    /**
+     * Should allow API headers
+     *
+     * If set to `true`, headers for `<MarkdownAPI>` title would also be extracted.
+     *
+     * @default true
+     */
+    shouldAllowApi?: boolean;
+    /**
+     * Should allow Example headers
+     *
+     * If set to `true`, headers for `<MarkdownExample>` title would also be extracted.
+     *
+     * @default true
+     */
+    shouldAllowExample?: boolean;
 }
 interface TocItem {
     id: string;
@@ -50,4 +66,5 @@ declare module '@md-plugins/shared' {
 
 declare const headersPlugin: PluginWithOptions<HeadersPluginOptions>;
 
-export { type HeadersPluginOptions, type TocItem, headersPlugin };
+export { headersPlugin };
+export type { HeadersPluginOptions, TocItem };

package/dist/index.mjs

@@ -1,74 +1,96 @@
-import { slugify } from '@md-plugins/shared';
+const andRE = /&/g;
+const rCombining = /[\u0300-\u036F]/g;
+const rControl = /[\u0000-\u001f]/g;
+const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
+const slugify = (str) => str.trim().replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase().normalize("NFKD").replace(rCombining, "").replace(andRE, "-and-").replace(rControl, "-").replace(rSpecial, "-").replace(/[^a-z0-9-]+/g, "").replace(/([a-z])(\d)/g, "$1-$2").replace(/(\d)([a-z])/g, "$1-$2").replace(/-{2,}/g, "-").replace(/(^-|-$)/g, "").replace(/^(\d)/, "_$1");
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
 
-const titleRE = /<\/?[^>]+(>|$)/g;
-const apiRE = /^<MarkdownApi /;
-const apiNameRE = /(?:file|name)="([^"]+)"/;
-const installationRE = /^<MarkdownInstallation(?:\s+title="([^"]*)")?\s*/;
-const exampleRE = /^<MarkdownExample(?:\s+title="([^"]*)")?\s*/;
-function parseContent(str, slugify$1 = slugify, format = (_str) => _str) {
-  const title = String(str).replace(titleRE, "").trim();
+const DEFAULT_HEADERS_PLUGIN_OPTIONS = {
+  level: [2, 3],
+  slugify: slugify,
+  // Default to an identity function if no formatter is provided.
+  format: (str) => str,
+  shouldAllowNested: false,
+  shouldAllowApi: true,
+  shouldAllowExample: true
+};
+function parseContent(str, slugify, format) {
+  const title = String(str).replace(/<\/?[^>]+(>|$)/g, "").trim();
   return {
-    id: slugify$1(title),
-    title: format(title) ?? title
+    id: slugify(title),
+    title: format(title)
   };
 }
-const headersPlugin = (md, {
-  level = [2, 3],
-  slugify: slugify$1 = slugify,
-  format
-} = {}) => {
+const headersPlugin = (md, options) => {
+  const {
+    level = DEFAULT_HEADERS_PLUGIN_OPTIONS.level,
+    slugify = DEFAULT_HEADERS_PLUGIN_OPTIONS.slugify,
+    format = DEFAULT_HEADERS_PLUGIN_OPTIONS.format,
+    shouldAllowApi = DEFAULT_HEADERS_PLUGIN_OPTIONS.shouldAllowApi,
+    shouldAllowExample = DEFAULT_HEADERS_PLUGIN_OPTIONS.shouldAllowExample
+  } = resolvePluginOptions(
+    options,
+    "headersPlugin",
+    DEFAULT_HEADERS_PLUGIN_OPTIONS
+  );
   const originalHeadingOpen = md.renderer.rules.heading_open;
   const originalHtmlBlock = md.renderer.rules.html_block;
-  md.renderer.rules.heading_open = (tokens, idx, options, env, self) => {
+  md.renderer.rules.heading_open = (tokens, idx, options2, env, self) => {
     const token = tokens[idx];
     if (!token) {
-      return self.renderToken(tokens, idx, options);
+      return self.renderToken(tokens, idx, options2);
     }
     const headerLevel = Number.parseInt(token.tag.slice(1), 10);
     const contentToken = tokens[idx + 1];
     const content = contentToken && contentToken.children ? contentToken.children.reduce((acc, t) => acc + t.content, "") : "";
-    const { id, title } = parseContent(content, slugify$1, format);
+    const { id, title } = parseContent(content, slugify, format);
     token.attrSet("id", id);
     token.attrSet("class", `markdown-heading markdown-${token.tag}`);
     token.attrSet("@click", `copyHeading(\`${id}\`)`);
     env.toc = env.toc || [];
-    if (level.includes(headerLevel)) {
-      if (headerLevel === level[0]) {
+    if ((level ?? []).includes(headerLevel)) {
+      if (headerLevel === (level ?? [])[0]) {
         env.toc.push({ id, title });
       } else {
         env.toc.push({ id, title, sub: true });
       }
     }
     if (typeof originalHeadingOpen === "function") {
-      return originalHeadingOpen(tokens, idx, options, env, self);
+      return originalHeadingOpen(tokens, idx, options2, env, self);
     }
-    return self.renderToken(tokens, idx, options);
+    return self.renderToken(tokens, idx, options2);
   };
-  md.renderer.rules.html_block = (tokens, idx, options, env, self) => {
+  md.renderer.rules.html_block = (tokens, idx, options2, env, self) => {
     const token = tokens[idx];
     if (!token) {
       return "";
     }
     env.toc = env.toc || [];
-    if (apiRE.test(token.content)) {
-      const match2 = apiNameRE.exec(token.content);
-      if (match2 !== null) {
-        const title = `${match2[1]} API`;
-        env.toc.push({ id: slugify$1(title), title, deep: true });
+    if (shouldAllowApi && /^<MarkdownApi\s/.test(token.content)) {
+      const match = /(?:file|name)="([^"]+)"/.exec(token.content);
+      if (match !== null) {
+        const title = `${match[1]} API`;
+        if (slugify) {
+          env.toc.push({ id: slugify(title), title, deep: true });
+        }
       }
     }
-    let match = token.content.match(installationRE);
-    if (match !== null) {
-      const title = match[1] ?? "Installation";
-      env.toc.push({ id: slugify$1(title), title, deep: true });
-    }
-    match = token.content.match(exampleRE);
-    if (match !== null) {
-      const title = match[1] ?? "Example";
-      env.toc.push({ id: slugify$1(title), title, deep: true });
+    if (shouldAllowExample && /^<MarkdownExample(?:\s+title="([^"]*)")?\s*/.test(token.content)) {
+      const match = token.content.match(/^<MarkdownExample(?:\s+title="([^"]*)")?\s*/);
+      if (match !== null) {
+        const title = match[1] ?? "Example";
+        if (slugify) {
+          env.toc.push({ id: slugify("example-" + title), title, deep: true });
+        }
+      }
     }
     if (typeof originalHtmlBlock === "function") {
-      return originalHtmlBlock(tokens, idx, options, env, self);
+      return originalHtmlBlock(tokens, idx, options2, env, self);
     }
     return token.content;
   };

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@md-plugins/md-plugin-headers",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.0",
   "description": "A markdown-it plugin for handling headers (H1-H6).",
   "keywords": [
     "markdown-it",
     "quasarframework",
-    "vue",
-    "types"
+    "types",
+    "vue"
   ],
   "homepage": "https://github.com/md-plugins",
   "bugs": {
     "url": "https://github.com/md-plugins/md-plugins/issues"
   },
+  "license": "MIT",
+  "author": "hawkeye64 <galbraith64@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/md-plugins/md-plugins.git"
   },
-  "license": "MIT",
-  "author": "hawkeye64 <galbraith64@gmail.com>",
+  "files": [
+    "./dist"
+  ],
   "type": "module",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {
@@ -27,24 +32,17 @@
       }
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist"
-  ],
-  "dependencies": {
-    "markdown-it": "^14.1.0",
-    "@md-plugins/shared": "0.1.0-alpha.9"
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
-    "@types/markdown-it": "^14.1.2"
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.1",
+    "@md-plugins/shared": "0.1.0-beta.0"
   },
   "peerDependencies": {
     "markdown-it": "^14.1.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "unbuild",
     "clean": "rm -rf dist/ node_modules/",