Added plugin descriptions to plugin list #2076
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds plugin descriptions to the plugin list on the website.
Screenshot
My intention is to make plugins more accessible. I have a feeling that many users miss plugins or only know the really popular ones (Line numbers).
So to make the function of plugins more visible, I added the description of every plugin to the list, so users can broadly understand what a plugin is supposed to do; the name alone simply isn't enough. For further information, they can then click the link and read more.
The description of a plugin is the short paragraph every plugin page has, summarizing the plugin. For example, the desc of Auoloader is "Automatically loads the needed languages to highlight the code blocks". I extracted every one of them and put them into
components.json
, so it's accessible from various parts of the website (and because it's easy).To avoid redundancy and because the header of every plugin can now be generated, I added a little script to do just that. The header of every plugin is now a one-liner and
scripts/code.js
will add everything.