Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added plugin descriptions to plugin list #2076

Merged
merged 3 commits into from
Sep 30, 2019

Conversation

RunDevelopment
Copy link
Member

This adds plugin descriptions to the plugin list on the website.

Screenshot

image

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.

components.json Outdated Show resolved Hide resolved
components.json Outdated Show resolved Hide resolved
components.json Outdated Show resolved Hide resolved
RunDevelopment and others added 2 commits September 30, 2019 14:59
Co-Authored-By: James DiGioia <jamesorodig@gmail.com>
@RunDevelopment RunDevelopment merged commit cdfa60a into PrismJS:master Sep 30, 2019
@RunDevelopment RunDevelopment deleted the plugin-descriptions branch September 30, 2019 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants