markmap-lib 0.11.6 → 0.12.0

package/dist/index.esm.js

@@ -1,19 +1,20 @@
-/*! markmap-lib v0.11.6 | MIT License */
+/*! markmap-lib v0.12.0 | MIT License */
 import _extends from '@babel/runtime/helpers/esm/extends';
 import { persistCSS, persistJS, wrapFunction, Hook } from 'markmap-common';
 import { Remarkable } from 'remarkable';
 import remarkableKatex from 'remarkable-katex';
 import Prism from 'prismjs';
 import loadLanguages from 'prismjs/components/';
+import yaml from 'js-yaml';
 
 const template = "<!DOCTYPE html>\n<html>\n<head>\n<meta charset=\"UTF-8\">\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n<meta http-equiv=\"X-UA-Compatible\" content=\"ie=edge\">\n<title>Markmap</title>\n<style>\n* {\n  margin: 0;\n  padding: 0;\n}\n#mindmap {\n  display: block;\n  width: 100vw;\n  height: 100vh;\n}\n</style>\n<!--CSS-->\n</head>\n<body>\n<svg id=\"mindmap\"></svg>\n<!--JS-->\n</body>\n</html>\n";
-const BASE_JS = [`https://cdn.jsdelivr.net/npm/d3@${"6.6.0"}`, `https://cdn.jsdelivr.net/npm/markmap-view@${"0.2.6"}`].map(src => ({
+const BASE_JS = [`https://cdn.jsdelivr.net/npm/d3@${"6.7.0"}`, `https://cdn.jsdelivr.net/npm/markmap-view@${"0.2.7"}`].map(src => ({
   type: 'script',
   data: {
     src
   }
 }));
-function fillTemplate(data, assets, extra) {
+function fillTemplate(root, assets, extra) {
   if (typeof extra === 'function') {
     extra = {
       getOptions: extra
@@ -31,7 +32,7 @@ function fillTemplate(data, assets, extra) {
   const context = {
     getMarkmap: () => window.markmap,
     getOptions: extra.getOptions,
-    data
+    data: root
   };
   const jsList = [...persistJS(extra.baseJs), ...persistJS([...(scripts || []), {
     type: 'iife',
@@ -55,16 +56,23 @@ function fillTemplate(data, assets, extra) {
   return html;
 }
 
-const name$1 = 'katex';
-function transform$1(transformHooks) {
-  transformHooks.parser.tap((md, features) => {
+const name$2 = 'katex';
+function transform$2(transformHooks) {
+  let enableFeature = () => {};
+
+  transformHooks.parser.tap(md => {
     md.use(remarkableKatex);
     md.renderer.rules.katex = wrapFunction(md.renderer.rules.katex, {
       after: () => {
-        features[name$1] = true;
+        enableFeature();
       }
     });
   });
+  transformHooks.transform.tap((_, context) => {
+    enableFeature = () => {
+      context.features[name$2] = true;
+    };
+  });
   return {
     styles: [{
       type: 'stylesheet',
@@ -105,16 +113,18 @@ function transform$1(transformHooks) {
 
 var katex = /*#__PURE__*/Object.freeze({
 __proto__: null,
-name: name$1,
-transform: transform$1
+name: name$2,
+transform: transform$2
 });
 
-const name = 'prism';
-function transform(transformHooks) {
-  transformHooks.parser.tap((md, features) => {
+const name$1 = 'prism';
+function transform$1(transformHooks) {
+  let enableFeature = () => {};
+
+  transformHooks.parser.tap(md => {
     md.set({
       highlight: (str, lang) => {
-        features[name] = true;
+        enableFeature();
         let grammar = Prism.languages[lang];
 
         if (!grammar) {
@@ -130,11 +140,16 @@ function transform(transformHooks) {
       }
     });
   });
+  transformHooks.transform.tap((_, context) => {
+    enableFeature = () => {
+      context.features[name$1] = true;
+    };
+  });
   return {
     styles: [{
       type: 'stylesheet',
       data: {
-        href: `https://cdn.jsdelivr.net/npm/prismjs@${"1.23.0"}/themes/prism.css`
+        href: `https://cdn.jsdelivr.net/npm/prismjs@${"1.25.0"}/themes/prism.css`
       }
     }]
   };
@@ -142,6 +157,43 @@ function transform(transformHooks) {
 
 var prism = /*#__PURE__*/Object.freeze({
 __proto__: null,
+name: name$1,
+transform: transform$1
+});
+
+const name = 'frontmatter';
+function transform(transformHooks) {
+  transformHooks.transform.tap((md, context) => {
+    const origParse = md.parse;
+    md.parse = wrapFunction(origParse, {
+      before(ctx) {
+        const [content] = ctx.args;
+        if (!content.startsWith('---\n')) return;
+        const endOffset = content.indexOf('\n---\n');
+        if (endOffset < 0) return;
+        const raw = content.slice(4, endOffset);
+
+        try {
+          context.frontmatter = yaml.load(raw);
+        } catch (_unused) {
+          return;
+        }
+
+        const offset = endOffset + 5;
+        ctx.args[0] = content.slice(offset);
+      },
+
+      after() {
+        md.parse = origParse;
+      }
+
+    });
+  });
+  return {};
+}
+
+var frontmatter = /*#__PURE__*/Object.freeze({
+__proto__: null,
 name: name,
 transform: transform
 });
@@ -149,17 +201,13 @@ transform: transform
 function createTransformHooks() {
   return {
     parser: new Hook(),
+    transform: new Hook(),
     htmltag: new Hook(),
-
-    /**
-     * Indicate that the last transformation is not complete for reasons like
-     * lack of resources and is called when it is ready for a new transformation.
-     */
     retransform: new Hook()
   };
 }
 
-const plugins = [katex, prism];
+const plugins = [katex, prism, frontmatter];
 
 function cleanNode(node, depth = 0) {
   if (node.t === 'heading') {
@@ -214,12 +262,18 @@ function cleanNode(node, depth = 0) {
 
 class Transformer {
   constructor(plugins$1 = plugins) {
-    this.plugins = void 0;
-    this.hooks = void 0;
-    this.md = void 0;
-    this.assetsMap = void 0;
     this.plugins = plugins$1;
     this.hooks = createTransformHooks();
+    const assetsMap = {};
+
+    for (const {
+      name,
+      transform
+    } of plugins$1) {
+      assetsMap[name] = transform(this.hooks);
+    }
+
+    this.assetsMap = assetsMap;
     const md = new Remarkable({
       html: true,
       breaks: true,
@@ -232,16 +286,7 @@ class Transformer {
       }
     });
     this.md = md;
-    const assetsMap = {};
-
-    for (const {
-      name,
-      transform
-    } of plugins$1) {
-      assetsMap[name] = transform(this.hooks);
-    }
-
-    this.assetsMap = assetsMap;
+    this.hooks.parser.call(md);
   }
 
   buildTree(tokens) {
@@ -340,16 +385,17 @@ class Transformer {
   transform(content) {
     var _root$c;
 
-    const features = {};
-    this.hooks.parser.call(this.md, features);
-    const tokens = this.md.parse(content || '', {});
+    const context = {
+      features: {}
+    };
+    this.hooks.transform.call(this.md, context);
+    const tokens = this.md.parse(content, {});
     let root = this.buildTree(tokens);
     cleanNode(root);
     if (((_root$c = root.c) == null ? void 0 : _root$c.length) === 1) root = root.c[0];
-    return {
-      root,
-      features
-    };
+    return _extends({}, context, {
+      root
+    });
   }
   /**
    * Get all assets from enabled plugins or filter them by plugin names as keys.

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! markmap-lib v0.11.6 | MIT License */
+/*! markmap-lib v0.12.0 | MIT License */
 'use strict';
 
 var _extends = require('@babel/runtime/helpers/extends');
@@ -7,22 +7,24 @@ var remarkable = require('remarkable');
 var remarkableKatex = require('remarkable-katex');
 var Prism = require('prismjs');
 var loadLanguages = require('prismjs/components/');
+var yaml = require('js-yaml');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e['default'] : e; }
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
 
 var _extends__default = /*#__PURE__*/_interopDefaultLegacy(_extends);
 var remarkableKatex__default = /*#__PURE__*/_interopDefaultLegacy(remarkableKatex);
 var Prism__default = /*#__PURE__*/_interopDefaultLegacy(Prism);
 var loadLanguages__default = /*#__PURE__*/_interopDefaultLegacy(loadLanguages);
+var yaml__default = /*#__PURE__*/_interopDefaultLegacy(yaml);
 
 const template = "<!DOCTYPE html>\n<html>\n<head>\n<meta charset=\"UTF-8\">\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n<meta http-equiv=\"X-UA-Compatible\" content=\"ie=edge\">\n<title>Markmap</title>\n<style>\n* {\n  margin: 0;\n  padding: 0;\n}\n#mindmap {\n  display: block;\n  width: 100vw;\n  height: 100vh;\n}\n</style>\n<!--CSS-->\n</head>\n<body>\n<svg id=\"mindmap\"></svg>\n<!--JS-->\n</body>\n</html>\n";
-const BASE_JS = [`https://cdn.jsdelivr.net/npm/d3@${"6.6.0"}`, `https://cdn.jsdelivr.net/npm/markmap-view@${"0.2.6"}`].map(src => ({
+const BASE_JS = [`https://cdn.jsdelivr.net/npm/d3@${"6.7.0"}`, `https://cdn.jsdelivr.net/npm/markmap-view@${"0.2.7"}`].map(src => ({
   type: 'script',
   data: {
     src
   }
 }));
-function fillTemplate(data, assets, extra) {
+function fillTemplate(root, assets, extra) {
   if (typeof extra === 'function') {
     extra = {
       getOptions: extra
@@ -40,7 +42,7 @@ function fillTemplate(data, assets, extra) {
   const context = {
     getMarkmap: () => window.markmap,
     getOptions: extra.getOptions,
-    data
+    data: root
   };
   const jsList = [...markmapCommon.persistJS(extra.baseJs), ...markmapCommon.persistJS([...(scripts || []), {
     type: 'iife',
@@ -64,16 +66,23 @@ function fillTemplate(data, assets, extra) {
   return html;
 }
 
-const name$1 = 'katex';
-function transform$1(transformHooks) {
-  transformHooks.parser.tap((md, features) => {
+const name$2 = 'katex';
+function transform$2(transformHooks) {
+  let enableFeature = () => {};
+
+  transformHooks.parser.tap(md => {
     md.use(remarkableKatex__default);
     md.renderer.rules.katex = markmapCommon.wrapFunction(md.renderer.rules.katex, {
       after: () => {
-        features[name$1] = true;
+        enableFeature();
       }
     });
   });
+  transformHooks.transform.tap((_, context) => {
+    enableFeature = () => {
+      context.features[name$2] = true;
+    };
+  });
   return {
     styles: [{
       type: 'stylesheet',
@@ -114,16 +123,18 @@ function transform$1(transformHooks) {
 
 var katex = /*#__PURE__*/Object.freeze({
 __proto__: null,
-name: name$1,
-transform: transform$1
+name: name$2,
+transform: transform$2
 });
 
-const name = 'prism';
-function transform(transformHooks) {
-  transformHooks.parser.tap((md, features) => {
+const name$1 = 'prism';
+function transform$1(transformHooks) {
+  let enableFeature = () => {};
+
+  transformHooks.parser.tap(md => {
     md.set({
       highlight: (str, lang) => {
-        features[name] = true;
+        enableFeature();
         let grammar = Prism__default.languages[lang];
 
         if (!grammar) {
@@ -139,11 +150,16 @@ function transform(transformHooks) {
       }
     });
   });
+  transformHooks.transform.tap((_, context) => {
+    enableFeature = () => {
+      context.features[name$1] = true;
+    };
+  });
   return {
     styles: [{
       type: 'stylesheet',
       data: {
-        href: `https://cdn.jsdelivr.net/npm/prismjs@${"1.23.0"}/themes/prism.css`
+        href: `https://cdn.jsdelivr.net/npm/prismjs@${"1.25.0"}/themes/prism.css`
       }
     }]
   };
@@ -151,6 +167,43 @@ function transform(transformHooks) {
 
 var prism = /*#__PURE__*/Object.freeze({
 __proto__: null,
+name: name$1,
+transform: transform$1
+});
+
+const name = 'frontmatter';
+function transform(transformHooks) {
+  transformHooks.transform.tap((md, context) => {
+    const origParse = md.parse;
+    md.parse = markmapCommon.wrapFunction(origParse, {
+      before(ctx) {
+        const [content] = ctx.args;
+        if (!content.startsWith('---\n')) return;
+        const endOffset = content.indexOf('\n---\n');
+        if (endOffset < 0) return;
+        const raw = content.slice(4, endOffset);
+
+        try {
+          context.frontmatter = yaml__default.load(raw);
+        } catch (_unused) {
+          return;
+        }
+
+        const offset = endOffset + 5;
+        ctx.args[0] = content.slice(offset);
+      },
+
+      after() {
+        md.parse = origParse;
+      }
+
+    });
+  });
+  return {};
+}
+
+var frontmatter = /*#__PURE__*/Object.freeze({
+__proto__: null,
 name: name,
 transform: transform
 });
@@ -158,17 +211,13 @@ transform: transform
 function createTransformHooks() {
   return {
     parser: new markmapCommon.Hook(),
+    transform: new markmapCommon.Hook(),
     htmltag: new markmapCommon.Hook(),
-
-    /**
-     * Indicate that the last transformation is not complete for reasons like
-     * lack of resources and is called when it is ready for a new transformation.
-     */
     retransform: new markmapCommon.Hook()
   };
 }
 
-const plugins = [katex, prism];
+const plugins = [katex, prism, frontmatter];
 
 function cleanNode(node, depth = 0) {
   if (node.t === 'heading') {
@@ -223,12 +272,18 @@ function cleanNode(node, depth = 0) {
 
 class Transformer {
   constructor(plugins$1 = plugins) {
-    this.plugins = void 0;
-    this.hooks = void 0;
-    this.md = void 0;
-    this.assetsMap = void 0;
     this.plugins = plugins$1;
     this.hooks = createTransformHooks();
+    const assetsMap = {};
+
+    for (const {
+      name,
+      transform
+    } of plugins$1) {
+      assetsMap[name] = transform(this.hooks);
+    }
+
+    this.assetsMap = assetsMap;
     const md = new remarkable.Remarkable({
       html: true,
       breaks: true,
@@ -241,16 +296,7 @@ class Transformer {
       }
     });
     this.md = md;
-    const assetsMap = {};
-
-    for (const {
-      name,
-      transform
-    } of plugins$1) {
-      assetsMap[name] = transform(this.hooks);
-    }
-
-    this.assetsMap = assetsMap;
+    this.hooks.parser.call(md);
   }
 
   buildTree(tokens) {
@@ -349,16 +395,17 @@ class Transformer {
   transform(content) {
     var _root$c;
 
-    const features = {};
-    this.hooks.parser.call(this.md, features);
-    const tokens = this.md.parse(content || '', {});
+    const context = {
+      features: {}
+    };
+    this.hooks.transform.call(this.md, context);
+    const tokens = this.md.parse(content, {});
     let root = this.buildTree(tokens);
     cleanNode(root);
     if (((_root$c = root.c) == null ? void 0 : _root$c.length) === 1) root = root.c[0];
-    return {
-      root,
-      features
-    };
+    return _extends__default({}, context, {
+      root
+    });
   }
   /**
    * Get all assets from enabled plugins or filter them by plugin names as keys.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markmap-lib",
-  "version": "0.11.6",
+  "version": "0.12.0",
   "description": "Visualize your Markdown as mindmaps with Markmap",
   "author": "Gerald <gera2ld@live.com>",
   "license": "MIT",
@@ -11,8 +11,7 @@
     "dev": "rollup -wc rollup.conf.js",
     "clean": "del-cli dist types",
     "build:types": "tsc",
-    "build:js": "rollup -c rollup.conf.js",
-    "lint": "eslint --ext .ts ."
+    "build:js": "rollup -c rollup.conf.js"
   },
   "publishConfig": {
     "access": "public",
@@ -35,15 +34,17 @@
   ],
   "repository": "git@github.com:gera2ld/markmap.git",
   "devDependencies": {
-    "markmap-view": "^0.2.6"
+    "@types/remarkable": "^2.0.3",
+    "markmap-view": "^0.2.7"
   },
   "dependencies": {
-    "@babel/runtime": "^7.12.5",
-    "katex": "^0.12.0",
-    "markmap-common": "^0.1.5",
-    "prismjs": "^1.21.0",
-    "remarkable": "^2.0.0",
-    "remarkable-katex": "^1.1.6"
+    "@babel/runtime": "^7.16.3",
+    "js-yaml": "^4.1.0",
+    "katex": "^0.15.1",
+    "markmap-common": "^0.1.6",
+    "prismjs": "^1.25.0",
+    "remarkable": "^2.0.1",
+    "remarkable-katex": "^1.1.8"
   },
-  "gitHead": "c1b04d45e3d7a9be432c2980ee105983abac7470"
+  "gitHead": "fbec667e1706813f9f60bea6a971f3820858ca40"
 }

package/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from './types';
-export * from './template';
-export * from './transform';
+export * from './types';
+export * from './template';
+export * from './transform';

package/types/plugins/base.d.ts

@@ -1,10 +1,2 @@
-import { IWrapContext, Hook } from 'markmap-common';
-export declare function createTransformHooks(): {
-    parser: Hook<(md: any, features: any) => void>;
-    htmltag: Hook<(ctx: IWrapContext<any>) => void>;
-    /**
-     * Indicate that the last transformation is not complete for reasons like
-     * lack of resources and is called when it is ready for a new transformation.
-     */
-    retransform: Hook<() => void>;
-};
+import { ITransformHooks } from '../types';
+export declare function createTransformHooks(): ITransformHooks;

package/types/plugins/frontmatter.d.ts

@@ -0,0 +1,3 @@
+import { IAssets, ITransformHooks } from '../types';
+export declare const name = "frontmatter";
+export declare function transform(transformHooks: ITransformHooks): IAssets;

package/types/plugins/index.d.ts

@@ -1,4 +1,5 @@
-import * as katex from './katex';
-import * as prism from './prism';
-export * from './base';
-export declare const plugins: (typeof katex | typeof prism)[];
+import * as katex from './katex';
+import * as prism from './prism';
+import * as frontmatter from './frontmatter';
+export * from './base';
+export declare const plugins: (typeof katex | typeof prism | typeof frontmatter)[];

package/types/plugins/katex.browser.d.ts

@@ -1,3 +1,3 @@
-import { IAssets, ITransformHooks } from '../types';
-export declare const name = "katex";
-export declare function transform(transformHooks: ITransformHooks): IAssets;
+import { IAssets, ITransformHooks } from '../types';
+export declare const name = "katex";
+export declare function transform(transformHooks: ITransformHooks): IAssets;

package/types/plugins/katex.d.ts

@@ -1,3 +1,3 @@
-import { IAssets, ITransformHooks } from '../types';
-export declare const name = "katex";
-export declare function transform(transformHooks: ITransformHooks): IAssets;
+import { IAssets, ITransformHooks } from '../types';
+export declare const name = "katex";
+export declare function transform(transformHooks: ITransformHooks): IAssets;

package/types/plugins/prism.browser.d.ts

@@ -1,3 +1,3 @@
-import { IAssets, ITransformHooks } from '../types';
-export declare const name = "prism";
-export declare function transform(transformHooks: ITransformHooks): IAssets;
+import { IAssets, ITransformHooks } from '../types';
+export declare const name = "prism";
+export declare function transform(transformHooks: ITransformHooks): IAssets;

package/types/plugins/prism.d.ts

@@ -1,3 +1,3 @@
-import { IAssets, ITransformHooks } from '../types';
-export declare const name = "prism";
-export declare function transform(transformHooks: ITransformHooks): IAssets;
+import { IAssets, ITransformHooks } from '../types';
+export declare const name = "prism";
+export declare function transform(transformHooks: ITransformHooks): IAssets;

package/types/template.d.ts

@@ -1,6 +1,6 @@
-import { JSItem, INode } from 'markmap-common';
-import { IAssets } from './types';
-export declare function fillTemplate(data: INode | undefined, assets: IAssets, extra?: {
-    baseJs?: JSItem[];
-    getOptions?: () => any;
-} | (() => any)): string;
+import { JSItem, INode } from 'markmap-common';
+import { IAssets } from './types';
+export declare function fillTemplate(root: INode | undefined, assets: IAssets, extra?: {
+    baseJs?: JSItem[];
+    getOptions?: () => any;
+} | (() => any)): string;

package/types/transform.d.ts

@@ -1,22 +1,22 @@
-import { Remarkable } from 'remarkable';
-import { INode } from 'markmap-common';
-import { ITransformResult, ITransformPlugin, IAssets, IAssetsMap, ITransformHooks, IFeatures } from './types';
-import { plugins as builtInPlugins } from './plugins';
-export { builtInPlugins };
-export declare class Transformer {
-    plugins: ITransformPlugin[];
-    hooks: ITransformHooks;
-    md: Remarkable;
-    assetsMap: IAssetsMap;
-    constructor(plugins?: ITransformPlugin[]);
-    buildTree(tokens: any): INode;
-    transform(content: string): ITransformResult;
-    /**
-     * Get all assets from enabled plugins or filter them by plugin names as keys.
-     */
-    getAssets(keys?: string[]): IAssets;
-    /**
-     * Get used assets by features object returned by `transform`.
-     */
-    getUsedAssets(features: IFeatures): IAssets;
-}
+import { Remarkable } from 'remarkable';
+import { INode } from 'markmap-common';
+import { ITransformResult, ITransformPlugin, IAssets, IAssetsMap, ITransformHooks, IFeatures } from './types';
+import { plugins as builtInPlugins } from './plugins';
+export { builtInPlugins };
+export declare class Transformer {
+    plugins: ITransformPlugin[];
+    hooks: ITransformHooks;
+    md: Remarkable;
+    assetsMap: IAssetsMap;
+    constructor(plugins?: ITransformPlugin[]);
+    buildTree(tokens: Remarkable.Token[]): INode;
+    transform(content: string): ITransformResult;
+    /**
+     * Get all assets from enabled plugins or filter them by plugin names as keys.
+     */
+    getAssets(keys?: string[]): IAssets;
+    /**
+     * Get used assets by features object returned by `transform`.
+     */
+    getUsedAssets(features: IFeatures): IAssets;
+}