search

Raiondesu / eventhoven

Event manager that composes events effortlessly 🎵
https://www.npmjs.com/package/eventhoven
MIT License
5 stars 1 forks source link

Interactive documentation website #44

Open Raiondesu opened 5 years ago

Raiondesu commented 5 years ago

Is your feature request related to a problem? Please describe. Current README is getting very long and tedious to read. This might scare off some users that just want a simple event manager.

Describe the solution you'd like A powerful solution to this would be a custom website for documentation with a possibility to code interactive tutorials (vuepress-based, maybe)?

Describe alternatives you've considered Another solution would be to transfer docs to github wiki, but this provides no interactivity. And the structurization abilities are quire poor.

Raiondesu commented 5 years ago

A great solution would be to use typedoc and pipe it into vuepress for interactivity.

Raiondesu commented 5 years ago

Or, maybe, just https://github.com/GerkinDev/typedoc-plugin-tutorials will do.

Raiondesu commented 4 years ago

As it turns out, https://github.com/saberland/saber fits perfectly into this.