Evaluation

[Thomaash]

I was thinking about replacing our docs with something more pleasant to use than raw HTML and stumbled upon VuePress. The docs are in Markdown (though you can use YAML, HTML and even Vue in it) and everything else is handled by a few config files. It supports themes (the default one can pretty much only change colors but since the docs are in Markdown switching themes should be quite painless), search and internationalization (we have Korean docs for Vis Network for those who don't know). Plus there are many plugins with additional features.

I played a bit with it and created a working example: Code: https://github.com/visjs/experiment-vuepress/tree/master/vuepress Result: https://visjs.github.io/experiment-vuepress/documentation/

What do you think?

[mojoaxel]

:astonished: AMAZING!!!

[yotamberk]

WOW!! I LIKE!

[mojoaxel]

Here are a few thoughts on this topic:

• I realy like the look and feel of vuepress.
• The documentation of each project should be done in each project, so that they can go their own way (if the want/need to).
• The documentation would best be done in the code (e.g. tsdocs) and than generated from the code.
• Additional documentation should be done using markdown instead of html.
• It would be desirable that all projects use a similar/same style.