Improving "How to use plugins" documentation
See original GitHub issueHello and thank you very much everyone that has contributed for chartist,
I am openning this issue as I’d like to discuss a possible improvement in the plugins documentation:
The “How to use plugins” section starts with Once you have included a plugin in your project and takes it for granted that users know this means downloading the plugin, moving the appropriate files to the appropriate folder and including the scripts in the code. But, to a beginner with bower and the rest (like me, for example), these are not very clear (and I am still not sure I’ve done everything right). It also gets even more confusing when somebody looks at the tooltip
plugin github page and reads bower install chartist-plugin-tooltip --save
, assuming this is enough to “include” the plugin.
If you think the section can be improved I would be more than happy to go ahead and make a pull request with some more detailed instructions as written above.
Issue Analytics
- State:
- Created 8 years ago
- Comments:9
Top GitHub Comments
For those that read this thread and still haven’t found a usefull reference. Here is what seems to be working for me.
install plugin via npm e.g.
npm install chartist-plugin-pointlabels --save
register plugin with chartist:
use the plugin in your chart
We have recently updated the stack and backbone of Chartist, and we’re ready again to work on enhancements and plugins. We will need to rethink the v1.0.0 plugin mechanism again and how to support legacy plugins. Closing this, for now, if there’s still a need for fixes, please open a discussion again.