README.md

Markdown to Mindmap

This project aims to assist in the converting process of a Markdown file to a mindmap respecting the FreeMind XML Schema.

You'll finally be able to generate a mind map from a table of content of a Markdown file.

Installation

Please take a look at demo that demonstrates how to install this tool.

Usage

$("#button").on({
    click: function () {
        $().convertTOCtoMM({
            input:  $("#input"),  // Table of content input field selector
            output: $("#output")  // Output field selector to handle XML structure
        });
    }
});

Example

Input

- [Demo MindMap - Website](https://www.bmoine.fr/)
	- Home Page
	- Header
		- Logo
		- Navigation links
	- Side Bar
		- Search
		- Contact info
		- Newsletter box
		- RSS options
	- Footer
		- Navigation links
		- Images
		- Privacy policy
	- Sub pages
		- Projects
		- Board info
		- Branches
		- Customers

Note: Please, make sure you're using tab.

Output

<map version="1.0.1">
	<node TEXT="Demo MindMap - Website" LINK="https://www.bmoine.fr/">
		<node POSITION="right" TEXT="Home Page"></node>
		<node POSITION="left" TEXT="Header">
			<node TEXT="Logo"></node>
			<node TEXT="Navigation links"></node>
		</node>
		<node POSITION="right" TEXT="Side Bar">
			<node TEXT="Search"></node>
			<node TEXT="Contact info"></node>
			<node TEXT="Newsletter box"></node>
			<node TEXT="RSS options"></node>
		</node>
		<node POSITION="left" TEXT="Footer">
			<node TEXT="Navigation links"></node>
			<node TEXT="Images"></node>
			<node TEXT="Privacy policy"></node>
		</node>
		<node POSITION="right" TEXT="Sub pages">
			<node TEXT="Projects"></node>
			<node TEXT="Board info"></node>
			<node TEXT="Branches"></node>
			<node TEXT="Customers"></node>
		</node>
	</node>
</map>