Create a demo with customizable options

dundalek / markmap

Visualize markdown documents as mindmaps

MIT License

1.7k stars 175 forks source link

Create a demo with customizable options #23

Open dundalek opened 5 years ago

dundalek commented 5 years ago

It would be cool to create a demo showing different customization options using dat.gui.

This is a good ticket to take on if anyone is looking to start contributing to open source. I can provide necessary guidance.

ATouhou commented 5 years ago

The demo is actually your project "kmdoc" right? but using markmap for the mindmap?

dundalek commented 5 years ago

No, kmdoc already uses markmap but that's not what I meant.

I created some examples in the examples subfolder how to integrate markmap in other projects and parse different formats. So it would be cool to create an another demo example. The demo would show off that functionality including switching different themes and visualization options.

imma90 commented 5 years ago

@dundalek , just to be sure, what are the customization options you mean?

In the examples, there are two settings:

preset, which can have the values colorful or default (result already shown in the readme)
linkShape, which can have the values diagonal or bracket Are you talking about these settings?

If so, quickest might be to extend the documentation in readme.md (I'd be happy to make that as first contribution) - this could already be helpful for users. An interactive demo using dat.gui might look more fancy, though.

dundalek commented 5 years ago

@imma90 That would be cool. There are bunch more undocumented options here: https://github.com/dundalek/markmap/blob/master/lib/view.mindmap.js#L74