markmap-lib

将 Markdown 转换为 markmap 使用的数据。

安装

$ npm install markmap-lib

或者从 CDN 加载：

<script src="https://cdn.jsdelivr.net/npm/markmap-lib"></script>
<script>
    const { Transformer } = window.markmap;
</script>

用法

导入

使用内置插件：

import { Transformer, builtInPlugins } from 'markmap-lib';

// 使用默认插件
const transformer = new Transformer();

// 使用额外插件
const transformer = new Transformer([...builtInPlugins, myPlugin]);

没有内置插件（自 v0.16.0 起）：

import { Transformer } from 'markmap-lib/no-plugins';
import { pluginFrontmatter } from 'markmap-lib/plugins';

// 完全没有插件
const transformer = new Transformer();

// 使用指定插件
const transformer = new Transformer([pluginFrontmatter]);

转换

解析 Markdown 并创建节点树，返回根节点和一个 features 对象，包含解析过程中活动的特性。

将 Markdown 转换为 markmap 数据：

// 1. 转换 Markdown
const { root, features } = transformer.transform(markdown);

// 2. 获取资产
// 获取所需特性的资产
const assets = transformer.getUsedAssets(features);

// 或获取所有可能稍后使用的资产
const assets = transformer.getAssets();

现在我们有了用于渲染的数据。

下一步

使用 markmap-render 生成交互式 HTML。

或者使用 markmap-view 进行编程调用。