Pages: misleading description about deprecated code highlighter `pygments`

[muzimuzhi]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's 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

• Dependency versions | GitHub Pages https://pages.github.com/versions/
• https://github.com/github/pages-gem/issues/651

Additional information

What "Pygments has been deprecated and not supported in Jekyll 4." (added in https://github.com/github/docs/commit/724a274245fa9e90df3f5d19114e4efb91de506f) 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

• by GitHub Pages in https://github.com/github/pages-gem/commit/10b6ca7cb889188c7afb51010a52cfcc633ff1e5 committed on 2015-10-27 and shipped with github-pages gem package v44 on 2016-02-02 and
• by Jekyll in https://github.com/jekyll/jekyll/commit/4707017936ce0dd600bf6e0c339960058c524edf committed on 2018-09-27 and shipped with Jekyll v4.0.0 on 2019-08-20, which is 3.5 years later.

[janiceilene]

👋 @muzimuzhi Thanks so much for opening an issue! I'll get this triaged for review ✨

[Alexx65we39]

Ok

[Alexx65we39]

Ok

[sophietheking]

@muzimuzhi 👋 Thanks for opening this issue and contributing to our Docs, we really appreciate it. It looks like everything after the comma can be can be removed:

, which is compatible with Pygments. Pygments has been deprecated and not supported in Jekyll 4.

So it reads:

By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the Rouge highlighter.

You or anyone else is welcome to open a PR. 🔨

[janbrasna]

@sophietheking Actually I think the compatibility bit is important, so I've kept it in #31808 — otherwise agree.

[muzimuzhi]

@janbrasna Agreed with you. And thank you.