markmap-lib

Transformar Markdown en datos utilizados por Markmap.

Instalación

$ npm install markmap-lib

O cargar desde CDN:

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

Uso

Importando

Con plugins incorporados:

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

// Con plugins predeterminados
const transformer = new Transformer();

// Con plugins adicionales
const transformer = new Transformer([...builtInPlugins, myPlugin]);

Sin plugins incorporados (desde la versión v0.16.0):

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

// Sin ningún plugin
const transformer = new Transformer();

// Con plugins especificados
const transformer = new Transformer([pluginFrontmatter]);

Transformación

Analizar Markdown y crear un árbol de nodos, devolver el nodo raíz y un objeto features que contiene las características activas durante el análisis.

Transformar Markdown a datos de Markmap:

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

// 2. obtener activos
// obtener activos requeridos por las características utilizadas
const assets = transformer.getUsedAssets(features);

// o obtener todos los activos posibles que podrían usarse más tarde
const assets = transformer.getAssets();

Ahora tenemos los datos para la representación.

Siguiente paso

Generar HTML interactivo usando markmap-render.

O usarlo programáticamente con markmap-view.