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

markdown: GFM does not include permalink contents #106

Open
rectalogic opened this issue Jan 22, 2024 · 3 comments
Open

markdown: GFM does not include permalink contents #106

rectalogic opened this issue Jan 22, 2024 · 3 comments

Comments

@rectalogic
Copy link

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
Copy link

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!

@janbrasna
Copy link

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 github/docs#34334 instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants