pygments / pygments/pygments

[Documentation] Improve languages list page

Open
#2,202 0 comments 0 reactions 0 assignees View on GitHub

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:

https://github.com/pygments/pygments/blob/7620ef295ee9ac3ad2723847bc6722b5beec248e/doc/_templates/languages.html#L10-L17

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:

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.