Skip to content

This package provides tooling around translating freeplane mindmap files into other useful formats

License

Notifications You must be signed in to change notification settings

shollingsworth/freeplane_tools

Repository files navigation

github-issues github-languages-code-size github-stars github-forks

pypi-v pypi-status pypi-l pypi-dm pypi-pyversions pypi-implementation

TOC

Freeplane Tools

If you hate writing Markdown, but love mindmaps (and using freeplane this toolset is for you.

These python programs aim to ease translating a mindmap into various markdown formats.

This document README.md was made with mm2github.py with  README.mm as a source.

Enjoy!

Pull requests welcome. :)

Installation

To install this package from pypy run the following command.


pip3 install freeplane_tools

License

See: LICENSE

Quickstart

Run the following if you want a quick demo of how this works. Have freeplane installed before running this.


pip3 install freeplane_tools

mm2template.py mymindmap.mm

freeplane mymindmap.mm

# do your editing in freeplane

mm2github.py -w mymindmap.mm


This will create: mymindmap.md

Example

Just want to look?

This mindmap produces the following markdown

CLI Commands

mm2bitbucket_server.py

usage: mm2bitbucket_server.py [-h] [-w] [-o OUTFILE] mindmap_file

Convert a Freeplane Mindmap to Bitbucket Markdown.

positional arguments:
  mindmap_file          mindmap_file help

optional arguments:
  -h, --help            show this help message and exit
  -w, --write           write markdown file
  -o OUTFILE, --outfile OUTFILE


mm2github.py

usage: mm2github.py [-h] [-w] [-o OUTFILE] mindmap_file

Convert a Freeplane Mindmap to Github Markdown.

positional arguments:
  mindmap_file          mindmap_file help

optional arguments:
  -h, --help            show this help message and exit
  -w, --write           write markdown file
  -o OUTFILE, --outfile OUTFILE


mm2template.py

usage: mm2template.py [-h] dest_file

Copy a Mindmap Template to destination file.

positional arguments:
  dest_file   destination file

optional arguments:
  -h, --help  show this help message and exit


Building

os / Package prerequisites:


pip3 install twine pydoctor

  • Install Locally from current branch
    • make install_local
  • Build Package
    • make pkg
  • Release
    • make documentation
      • Make sure git tree is clean
    • make bump_release
    • make release

Other Docs

About

This package provides tooling around translating freeplane mindmap files into other useful formats

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages