mikel-markdown 0.28.0 → 0.29.0

package/index.js

@@ -41,8 +41,15 @@ const allExpressions = {
         regex: /^(#+)\s+(.*)/gm,
         replace: (args, opt) => {
             const level = args[1].length;
-            const cn = [opt.classNames?.heading, opt.classNames?.["heading" + level]];
-            return render("h" + level, {class: cn.filter(Boolean).join(" ")}, args[2]);
+            const headingClassNames = [
+                opt.classNames?.heading,
+                opt.classNames?.["heading" + level]
+            ];
+            const headingProps = {
+                class: headingClassNames.filter(Boolean).join(" "),
+                name: args[2].toLowerCase().replaceAll(" ", "-"),
+            };
+            return render("h" + level, headingProps, args[2]);
         },
     },
     blockquote: {
@@ -141,8 +148,13 @@ const getInlineExpressions = expressions => {
 // @description markdown parser
 const parser = (str = "", options = {}) => {
     const expressions = options?.expressions || allExpressions; // custom expressions
+    const hooks = options?.hooks || {};
     const ignoredBlocks = []; // chunks to ignore
     str = str.replace(/\r\n/g, "\n");
+    // call preprocess hook
+    if (typeof hooks?.preprocess === "function") {
+        str = hooks.preprocess(str, options);
+    }
     // ignore html blocks
     const htmlBlockRegex = /<!--html-->([\s\S]*?)<!--\/html-->/gm;
     str = str.replace(htmlBlockRegex, match => {
@@ -152,7 +164,22 @@ const parser = (str = "", options = {}) => {
     // replace all expressions
     Object.keys(expressions).forEach(key => {
         str = str.replace(expressions[key].regex, (...args) => {
-            const value = expressions[key].replace(args, options);
+            // call the before render hook
+            if (typeof hooks?.beforeRender === "function") {
+                const newArgs = hooks.beforeRender(key, args, options);
+                if (newArgs && Array.isArray(newArgs)) {
+                    args = newArgs;
+                }
+            }
+            // get the result
+            let value = expressions[key].replace(args, options);
+            // call the after render hook
+            if (typeof hooks?.afterRender === "function") {
+                let newValue = hooks.afterRender(value, key, args, options);
+                if (typeof newValue === "string" && newValue !== value) {
+                    value = newValue;
+                }
+            }
             if (key === "pre" || key === "code") {
                 ignoredBlocks.push(value);
                 return `<!--HTML-BLOCK-${(ignoredBlocks.length - 1)}-->`;
@@ -169,6 +196,10 @@ const parser = (str = "", options = {}) => {
     ignoredBlocks.forEach((block, index) => {
         str = str.replace(`<!--HTML-BLOCK-${index}-->`, block);
     });
+    // call postprocess hook
+    if (typeof hooks?.postprocess === "function") {
+        str = hooks.postprocess(str, options);
+    }
     return str;
 };
 
@@ -178,7 +209,26 @@ const markdownPlugin = (options = {}) => {
     return {
         helpers: {
             markdown: params => {
-                return parser(params.fn(params.data) || "", options);
+                const tableOfContents = [];
+                const result = parser(params.fn(params.data) || "", {
+                    ...options,
+                    hooks: {
+                        beforeRender: (key, args) => {
+                            if (key === "heading") {
+                                tableOfContents.push({
+                                    level: args[1].length,
+                                    text: args[2],
+                                    slug: args[2].toLowerCase().replaceAll(" ", "-"),
+                                });
+                            }
+                        },
+                    },
+                });
+                // create a new variable @toc with the generated table of contents
+                Object.assign(params.variables, {
+                    "toc": tableOfContents,
+                });
+                return result;
             },
             inlineMarkdown: params => {
                 return parser(params.fn(params.data) || "", {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel-markdown",
     "description": "A mikel helper for parsing markdown content.",
-    "version": "0.28.0",
+    "version": "0.29.0",
     "type": "module",
     "license": "MIT",
     "author": {