Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
janbrasna opened this issue Aug 17, 2024 · 3 comments
Open
1 task done
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR

Comments

@janbrasna
Copy link
Contributor

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 actions/jekyll-build-pages#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 #32988 (comment) and below wrt differences in products +link to Jekyll-only specific issue in the past.

@janbrasna janbrasna added the content This issue or pull request belongs to the Docs Content team label Aug 17, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 17, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels Aug 19, 2024
@nguyenalex836
Copy link
Contributor

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

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Aug 19, 2024
Copy link
Contributor

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

@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR pages Content related to GitHub Pages and removed waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages needs SME This proposal needs review from a subject matter expert labels Aug 27, 2024
@nguyenalex836
Copy link
Contributor

@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 ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

3 participants