question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improving "How to use plugins" documentation

See original GitHub issue

Hello 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:closed
  • Created 8 years ago
  • Comments:9

github_iconTop GitHub Comments

4reactions
rodhowardcommented, Apr 30, 2019

For those that read this thread and still haven’t found a usefull reference. Here is what seems to be working for me.

  1. install plugin via npm e.g. npm install chartist-plugin-pointlabels --save

  2. register plugin with chartist:

    import Chartist from "chartist";
    // some pain points here bar plugin needed it declared on the window :(
    window["Chartist"] = Chartist;
    
    const pointLabels = require("chartist-plugin-pointlabels");
    const barLabels = require("chartist-plugin-barlabels");
    
    pointLabels();
    barLabels();
    
  3. use the plugin in your chart

    const chartConfig = {
      plugins: [
        Chartist.plugins.ctPointLabels({
          textAnchor: "middle",
          labelOffset: {
            x: 0,
            y: -10
          },
          labelInterpolationFnc: value => value || ""
        })
      ]
    };
    
0reactions
gionkunzcommented, Aug 9, 2022

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Improve a plugin tutorial - Jenkins
This blog post introduces the "Improve a plugin" developer tutorial for new contributors. The tutorial is a result of the "Contributing to ...
Read more >
betterdocs wordpress documentation plugin developer
Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer ... Use Simple Language For Your Plugin Documentation.
Read more >
Guide to the Plugin Documentation Standard - Apache Maven
The standard is not a set of rules but a guide to help plugin developers document their plugins better, for the benefit of...
Read more >
BetterDocs – Best Documentation & Knowledge Base Plugin
A better Documentation and Knowledgebase plugin for WordPress. Create better Docs, Knowledge Base and Wiki and manage them in a beautiful modern drag...
Read more >
Working with Plugins - Omeka Classic User Manual
Instructions are available on each plugin's documentation page. Note. Not every plugin will work with every version of Omeka, especially newer plugins on ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found