markmap icon indicating copy to clipboard operation
markmap copied to clipboard

Create a demo with customizable options

Open dundalek opened this issue 6 years ago • 4 comments

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.

dundalek avatar Sep 10 '18 21:09 dundalek

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

ATouhou avatar Sep 16 '18 14:09 ATouhou

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.

dundalek avatar Sep 18 '18 09:09 dundalek

@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.

imma90 avatar Nov 18 '18 17:11 imma90

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

dundalek avatar Nov 19 '18 12:11 dundalek