markmap-lib

Transformar Markdown em dados usados pelo markmap.

Instalação

$ npm install markmap-lib

Ou carregue a partir do CDN:

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

Uso

Importando

Com plugins embutidos:

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

// Com plugins padrão
const transformer = new Transformer();

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

Sem plugins embutidos (desde v0.16.0):

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

// Sem plugin algum
const transformer = new Transformer();

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

Transformação

Parse Markdown e crie uma árvore de nós, retornando o nó raiz e um features objeto contendo as características ativas durante o parsing.

Transformar Markdown em dados markmap:

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

// 2. obter ativos
// obter os ativos necessários pelas características usadas
const assets = transformer.getUsedAssets(features);

// ou obter todos os ativos possíveis que poderiam ser usados mais tarde
const assets = transformer.getAssets();

Agora temos os dados para renderização.

Próximo Passo

Gere HTML interativo usando markmap-render.

Ou use-o programaticamente com markmap-view.