Skip to content

Pages: misleading description about deprecated code highlighter pygments #30152

Closed
@muzimuzhi

Description

@muzimuzhi

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting

What part(s) of the article would you like to see updated?

Currently the section "Syntax highlighting" says

By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the Rouge highlighter, which is compatible with Pygments. Pygments has been deprecated and not supported in Jekyll 4.

This may mislead readers that GitHub Pages already uses Jekyll 4, while actually it still uses Jekyll 3.9.3. See

Additional information

What "Pygments has been deprecated and not supported in Jekyll 4." (added in 724a274) said is true, but it's not the appropriate reason. pgyments was deprecated because GitHub Pages wanted to, not because the version of Jekyll used by GitHub Pages dropped support for it.

Pygments support was dropped

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issuepagesContent related to GitHub Pages

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions