search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.07k stars 59.21k forks source link

Jekyll GFM processor claims it "will always match the results you see on GitHub" #34334

Open janbrasna opened 3 weeks ago

janbrasna commented 3 weeks ago

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/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll

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

Originally posted by @rectalogic in https://github.com/actions/jekyll-build-pages/issues/106

"only our GFM processor will always match the results you see on GitHub"

That is not true, GFM hasn't added the newer dotcom features as callouts, diagrams, ToC etc. so this sounds too bold given the discrepancies.

Additional information

Additional info https://github.com/github/docs/issues/32988#issuecomment-2117744517 and below wrt differences in products +link to Jekyll-only specific issue in the past.

nguyenalex836 commented 3 weeks ago

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

github-actions[bot] commented 3 weeks ago

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:

nguyenalex836 commented 2 weeks ago

@janbrasna Thank you for your patience while our team reviewed! They are in agreement with you that the wording should changed to reflect reality 💛

I've added the help wanted label so that you, or anyone else, may make this update ✨