markmap-anywidget 0.2.0

Interactive mindmaps from markdown using markmap

markmap-anywidget

A simple anywidget implementation of markmap for Jupyter and marimo notebooks.

Installation

PyPI:

pip install markmap-anywidget

Nix:

# your flake.nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
    markmap-anywidget.url = "github:daniel-fahey/markmap-anywidget";
  };

  outputs = { nixpkgs, markmap-anywidget, ... }:
    let
      system = "x86_64-linux";
      pkgs = nixpkgs.legacyPackages.${system};
    in {
      devShells.${system}.default = pkgs.mkShell {
        packages = [
          (pkgs.python3.withPackages (ps: [
            markmap-anywidget.packages.${system}.default
          ]))
        ];
      };
    };
}

Usage

See the marimo documentation for more information.

import marimo as mo
from markmap_anywidget import MarkmapWidget

widget = mo.ui.anywidget(
    MarkmapWidget(
        markdown_content="""---
markmap:
  colorFreezeLevel: 2
  maxWidth: 300
---

# markmap

## Links
- [Website](https://markmap.js.org/)
- [GitHub](https://github.com/gera2ld/markmap)

## Features
- `inline code`
- **strong** and *italic*
- Katex: $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
"""
    )
)

widget

Development

git clone [e-mail]:daniel-fahey/markmap-anywidget.git
cd markmap-anywidget

nix develop -c bun run build                  # rebuild static assets
nix develop -c marimo run examples/marimo.py  # test widget

Tests run automatically in the Nix build.

Releasing

# Update version
echo "0.3.0" > VERSION
nix develop -c bun run build

# Commit and tag
git add -A && git commit -m "v0.3.0"
git tag v0.3.0 && git push --tags

# Create release on GitHub (publishes to PyPI automatically)