markmap-cli

library0.18.12jsnpmunverified

markmap-cli v0.18.12 is a command-line tool to convert Markdown files into interactive mind maps (markmaps). It uses the markmap library to parse Markdown and generate HTML output. This version requires Node.js >=18 and is ESM-only (no CommonJS support). Drop-in replacement for generating mindmap HTML from Markdown files. Frequently updated, with breaking changes in recent versions including async setData, INode type changes, and migration from Prism.js to highlight.js.

data web-framework

github ↗package ↗homepage ↗

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Package name is markmap-cli, but the binary is markmap. Use npx markmap.

npx markmap-cli input.md

ESM-only since v0.15.0. CommonJS require() will throw.

import markmap from 'markmap-cli'

INode type is exported from markmap-common, not markmap-cli.

import { INode } from 'markmap-common'

Generates an interactive mindmap HTML from a Markdown file using the CLI.

npx markmap-cli@0.18.12 README.md -o mindmap.html

markmap --version

Debug

Known footguns

breakingNode data type changed to INode (breaking in v0.18.0)

breakingsetData is now asynchronous (breaking in v0.18.0)

breakingSwitched from Prism.js to highlight.js (breaking in v0.15.0)

breakingDropped CJS support (breaking in v0.15.0)

deprecatedPrism.js removed in v0.15.0, highlighting is now highlight.js

gotchaScript must be run as a module or with top-level await for async operations

Upgrade

Version history

Breaking-change detection hasn't run for this library yet.

Audit

Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity

0 hits · last 30 days

No traffic data recorded yet.

Resources

githubhttps://github.com/markmap/markmap ↗

packagehttps://www.npmjs.com/package/markmap-cli ↗

homepagehttps://markmap.js.org ↗