[Documentation] Improve languages list page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 885
- PR merge metrics
- No merged PRs in 30d
Description
Idea
It would be nice to enhance the page that list supported languages (https://pygments.org/languages/) to add the corresponding alias / keyword / CSS class.
Resources
The template to modify:
The mapping between the name and the aliases is already done here: https://github.com/pygments/pygments/blob/master/pygments/lexers/_mapping.py
Example of other syntax highlighters that is already doing that on their documentation:
- List: https://prismjs.com/#supported-languages
- Table: https://highlightjs.readthedocs.io/en/latest/supported-languages.html
Motivation
Some mapping are trivial but some others are non-intuitive or have many aliases. The page list the name of the languages supported but not the aliases which is the information users will need if they build a website using pygments (devs) or are just end users using a solution that use pygments. So having the mapping on the documentation and not only on the source code will be very helpful.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with doc/_templates/languages.html and compare its current output with pygments/lexers/_mapping.py, which contains the language-to-alias mapping. Update the languages documentation page to show each language's corresponding alias, keyword, or CSS class as requested, then verify the generated page presents this information clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100