actions / jekyll-build-pages

A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.
https://pages.github.com
MIT License
79 stars 35 forks source link

markdown: GFM does not include permalink contents #106

Open rectalogic opened 7 months ago

rectalogic commented 7 months ago

Docs say:

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

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

I have a pages site configured with markdown: GFM but the way github renders my README.md is different than the jekyll generated page.

I reference a repository permalink in the markdown and github renders this inline in the page:

image

The jekyll generated site does not, it just renders the URL:

image

See https://github.com/rectalogic/pagetest

janbrasna commented 1 month ago

There are differences between current GFM and features being available (only) on dotcom, think callouts, diagrams, different behavior of links, ToCs etc.

(The feature of expanding code permalink previews only works in the same repo — you won't get it across different repos, in wikis etc., so that's also not universally available.)

This seems more like a docs bug than anything. I can't seem to be able to find the quote you referred @rectalogic, could you point me to the exact location this is stated (as it's not correct and would need fixing)? Thanks!

rectalogic commented 1 month ago

The quote is on this page 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

janbrasna commented 1 month ago

D'oh! Thanks — I'll get it fixed, and also added to the list of pages that need a product callout reminding the differences.

You can close this issue, it really needs fixing in https://github.com/github/docs/issues/34334 instead.