Giter Club home page Giter Club logo

mindmap-markdown's Introduction

GitHub license

mindmap-markdown

Mindmap-markdown or mindmd converts Simplemind mind maps to markdown pages as an additional type to Simplemind's export function. Simplemind is an amazing mind mapping application that is free on mobile devices with significant capabilities to capture information.

One of the key missing components with Simplemind exports is that not all information is exported such as outer notes and relations. Plus, having a markdown outline of the mind map allows for notetaking apps like Obsidian or Logseq to consume the outline easily. Mindmd will export inner and outer notes, notes on node-to-node links, embedded and linked images, urls, and relations between nodes. Audio files (only audio links), node colors, checkboxes, mindmap-to-mindmap links and icons are not exported. The script will execute on Windows, MacOS or Linux.

Usage

To run mindmd you can either set your input and output paths in settings.cfg file, or, use the input -i or output -o switches to override the config file.

There are default paths already set in the settings.cfg file. However, you can simply test the script by running:

> python mindmd.py 

This will execute the example test .smmx file found in the mindmaps directory to see the markdown output. The default input path is the mindmaps folder. The default output path is the markdown folder. Output folders will be created dynamically. (Windows users should use forward slashes, e.g. -> c:/md-files/export)

Options

All configurations should first be setup in the settings.cfg file. If you need to run test files simply change the test_file_name to your .smmx file.

Switches

To specify a specfic input and output path and name:

> python mindmd.py -i mindmaps/inputname.smmx -o markdown/outputname.md

(paths will be pulled from the settings.cfg file if the -i or -o switches are not used)
If you need to use the same directory as mindmd, prefix the files with ./ like -i ./inputname.smmx. If an input or output switch isn't provided then the settings path with be used.

Batch

To run a batch conversion on a single directory:

> python mindmd.py -d

Mindmd will convert all .smmx files in a flat directory defined in settings.cfg (no subdirectories) using the same file name to markdown. You can also set the input directory with the -i switch:

> python mindmd.py -d -i mysmmxfolder

Line Numbers

To add line numbers to each node in the markdown output use:

> python mindmd.py -n

Note that the media path is relative to the output path in settings.cfg

Markdown

The markdown output will have a tree structure that is well suited for either Obsidian or Logseq notes. Bullets are added to be compatible with Logseq - but future versions will have a flag to remove them if needed.

An example output file can be found in the markdown directory

mindmap-markdown's People

Contributors

djsudduth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

mindmap-markdown's Issues

Canvas

Good afternoon, Don!
Perhaps you will have some free time this month to see how you can set up converting a file to *.canvas?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.