markmap-lib 0.11.6 → 0.13.0

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! markmap-lib v0.11.6 | MIT License */
+/*! markmap-lib v0.13.0 | MIT License */
 'use strict';
 
 var _extends = require('@babel/runtime/helpers/extends');
@@ -7,28 +7,27 @@ 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.13.0"}`].map(src => ({
   type: 'script',
   data: {
     src
   }
 }));
-function fillTemplate(data, assets, extra) {
-  if (typeof extra === 'function') {
-    extra = {
-      getOptions: extra
-    };
-  }
 
+const defaultGetOptions = (markmap, jsonOptions) => markmap.deriveOptions(jsonOptions);
+
+function fillTemplate(root, assets, extra) {
   extra = _extends__default({
     baseJs: BASE_JS
   }, extra);
@@ -39,24 +38,24 @@ function fillTemplate(data, assets, extra) {
   const cssList = [...(styles ? markmapCommon.persistCSS(styles) : [])];
   const context = {
     getMarkmap: () => window.markmap,
-    getOptions: extra.getOptions,
-    data
+    getOptions: extra.getOptions || defaultGetOptions,
+    jsonOptions: extra.jsonOptions,
+    root
   };
-  const jsList = [...markmapCommon.persistJS(extra.baseJs), ...markmapCommon.persistJS([...(scripts || []), {
+  const jsList = [...markmapCommon.persistJS([...extra.baseJs, ...(scripts || []), {
     type: 'iife',
     data: {
-      fn: (getMarkmap, getOptions, data) => {
-        const {
-          Markmap
-        } = getMarkmap();
-        window.mm = Markmap.create('svg#mindmap', getOptions == null ? void 0 : getOptions(), data);
+      fn: (getMarkmap, getOptions, root, jsonOptions) => {
+        const markmap = getMarkmap();
+        window.mm = markmap.Markmap.create('svg#mindmap', getOptions == null ? void 0 : getOptions(markmap, jsonOptions), root);
       },
       getParams: ({
         getMarkmap,
         getOptions,
-        data
+        root,
+        jsonOptions
       }) => {
-        return [getMarkmap, getOptions, data];
+        return [getMarkmap, getOptions, root, jsonOptions];
       }
     }
   }], context)];
@@ -64,16 +63,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,19 +120,21 @@ 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) {
+        if (!grammar && lang) {
           loadLanguages__default([lang]);
           grammar = Prism__default.languages[lang];
         }
@@ -139,11 +147,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.28.0"}/themes/prism.css`
       }
     }]
   };
@@ -151,6 +164,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,31 +208,27 @@ 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') {
+  if (node.type === 'heading') {
     // drop all paragraphs
-    node.c = node.c.filter(item => item.t !== 'paragraph');
-  } else if (node.t === 'list_item') {
-    var _node$p;
+    node.children = node.children.filter(item => item.type !== 'paragraph');
+  } else if (node.type === 'list_item') {
+    var _node$payload;
 
     // keep first paragraph as content of list_item, drop others
-    node.c = node.c.filter(item => {
-      if (['paragraph', 'fence'].includes(item.t)) {
-        if (!node.v) {
-          node.v = item.v;
-          node.p = _extends__default({}, node.p, item.p);
+    node.children = node.children.filter(item => {
+      if (['paragraph', 'fence'].includes(item.type)) {
+        if (!node.content) {
+          node.content = item.content;
+          node.payload = _extends__default({}, node.payload, item.payload);
         }
 
         return false;
@@ -191,16 +237,16 @@ function cleanNode(node, depth = 0) {
       return true;
     });
 
-    if (((_node$p = node.p) == null ? void 0 : _node$p.index) != null) {
-      node.v = `${node.p.index}. ${node.v}`;
+    if (((_node$payload = node.payload) == null ? void 0 : _node$payload.index) != null) {
+      node.content = `${node.payload.index}. ${node.content}`;
     }
-  } else if (node.t === 'ordered_list') {
-    var _node$p$start, _node$p2;
+  } else if (node.type === 'ordered_list') {
+    var _node$payload$startIn, _node$payload2;
 
-    let index = (_node$p$start = (_node$p2 = node.p) == null ? void 0 : _node$p2.start) != null ? _node$p$start : 1;
-    node.c.forEach(item => {
-      if (item.t === 'list_item') {
-        item.p = _extends__default({}, item.p, {
+    let index = (_node$payload$startIn = (_node$payload2 = node.payload) == null ? void 0 : _node$payload2.startIndex) != null ? _node$payload$startIn : 1;
+    node.children.forEach(item => {
+      if (item.type === 'list_item') {
+        item.payload = _extends__default({}, item.payload, {
           index
         });
         index += 1;
@@ -208,39 +254,23 @@ function cleanNode(node, depth = 0) {
     });
   }
 
-  if (node.c.length === 0) {
-    delete node.c;
+  if (node.children.length === 0) {
+    delete node.children;
   } else {
-    node.c.forEach(child => cleanNode(child, depth + 1));
+    node.children.forEach(child => cleanNode(child, depth + 1));
 
-    if (node.c.length === 1 && !node.c[0].v) {
-      node.c = node.c[0].c;
+    if (node.children.length === 1 && !node.children[0].content) {
+      node.children = node.children[0].children;
     }
   }
 
-  node.d = depth;
+  node.depth = depth;
 }
 
 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 md = new remarkable.Remarkable({
-      html: true,
-      breaks: true,
-      maxNesting: Infinity
-    });
-    md.block.ruler.enable(['deflist']);
-    md.renderer.rules.htmltag = markmapCommon.wrapFunction(md.renderer.rules.htmltag, {
-      after: ctx => {
-        this.hooks.htmltag.call(ctx);
-      }
-    });
-    this.md = md;
     const assetsMap = {};
 
     for (const {
@@ -251,19 +281,30 @@ class Transformer {
     }
 
     this.assetsMap = assetsMap;
+    const md = new remarkable.Remarkable('full', {
+      html: true,
+      breaks: true,
+      maxNesting: Infinity
+    });
+    md.renderer.rules.htmltag = markmapCommon.wrapFunction(md.renderer.rules.htmltag, {
+      after: ctx => {
+        this.hooks.htmltag.call(ctx);
+      }
+    });
+    this.md = md;
+    this.hooks.parser.call(md);
   }
 
   buildTree(tokens) {
     const {
       md
-    } = this; // TODO deal with <dl><dt>
-
+    } = this;
     const root = {
-      t: 'root',
-      d: 0,
-      v: '',
-      c: [],
-      p: {}
+      type: 'root',
+      depth: 0,
+      content: '',
+      children: [],
+      payload: {}
     };
     const stack = [root];
     let depth = 0;
@@ -282,7 +323,7 @@ class Transformer {
         if (type === 'heading') {
           depth = token.hLevel;
 
-          while (((_current = current) == null ? void 0 : _current.d) >= depth) {
+          while (((_current = current) == null ? void 0 : _current.depth) >= depth) {
             var _current;
 
             stack.pop();
@@ -291,27 +332,27 @@ class Transformer {
         } else {
           var _current2;
 
-          depth = Math.max(depth, ((_current2 = current) == null ? void 0 : _current2.d) || 0) + 1;
+          depth = Math.max(depth, ((_current2 = current) == null ? void 0 : _current2.depth) || 0) + 1;
 
           if (type === 'ordered_list') {
-            payload.start = token.order;
+            payload.startIndex = token.order;
           }
         }
 
         const item = {
-          t: type,
-          d: depth,
-          p: payload,
-          v: '',
-          c: []
+          type,
+          depth,
+          payload,
+          content: '',
+          children: []
         };
-        current.c.push(item);
+        current.children.push(item);
         stack.push(item);
       } else if (!current) {
         continue;
-      } else if (token.type === `${current.t}_close`) {
-        if (current.t === 'heading') {
-          depth = current.d;
+      } else if (token.type === `${current.type}_close`) {
+        if (current.type === 'heading') {
+          depth = current.depth;
         } else {
           stack.pop();
           depth = 0;
@@ -322,23 +363,23 @@ class Transformer {
           const data = comment == null ? void 0 : comment[1].trim();
 
           if (data === 'fold') {
-            current.p.f = true;
+            current.payload.fold = true;
             ctx.result = '';
           }
         });
         const text = md.renderer.render([token], md.options, {});
         revoke();
-        current.v = `${current.v || ''}${text}`;
+        current.content = `${current.content || ''}${text}`;
       } else if (token.type === 'fence') {
         let result = md.renderer.render([token], md.options, {}); // Remarkable only adds className to `<code>` but not `<pre>`, copy it to make PrismJS style work.
 
         const matches = result.match(/<code( class="[^"]*")>/);
         if (matches) result = result.replace('<pre>', `<pre${matches[1]}>`);
-        current.c.push({
-          t: token.type,
-          d: depth + 1,
-          v: result,
-          c: []
+        current.children.push({
+          type: token.type,
+          depth: depth + 1,
+          content: result,
+          children: []
         });
       } else ;
     }
@@ -347,18 +388,19 @@ class Transformer {
   }
 
   transform(content) {
-    var _root$c;
+    var _root$children;
 
-    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
-    };
+    if (((_root$children = root.children) == null ? void 0 : _root$children.length) === 1) root = root.children[0];
+    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.13.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.13.0"
   },
   "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.13.0",
+    "prismjs": "^1.25.0",
+    "remarkable": "^2.0.1",
+    "remarkable-katex": "^1.1.8"
   },
-  "gitHead": "c1b04d45e3d7a9be432c2980ee105983abac7470"
+  "gitHead": "4f5096be2e5ee0d666c0868dbb0d163b19b00ffe"
 }

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,8 @@
-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 type { IMarkmapOptions, IMarkmapJSONOptions } from 'markmap-view';
+import { IAssets } from './types';
+export declare function fillTemplate(root: INode | undefined, assets: IAssets, extra?: {
+    baseJs?: JSItem[];
+    jsonOptions?: IMarkmapJSONOptions;
+    getOptions?: (markmap: typeof window.markmap, jsonOptions: IMarkmapJSONOptions) => Partial<IMarkmapOptions>;
+}): 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;
+}