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

replace kramdown with GFM #210

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

replace kramdown with GFM #210

wants to merge 3 commits into from

Conversation

swantzter
Copy link
Member

@swantzter swantzter commented Feb 14, 2022

This swaps out the default kramdown renderer in Jekyll for GitHub pages' GFM renderer

There are pros and cons of this, the main benefits include that if it renders on GH when looking at a PR or commit, it will render the same on the site once it's deployed (something I noticed in the 2022-01 minutes where the code blocks in <details> rendered in GH, and to my knowledge would render as expected in jekyll, and then didn't)

Most downsides I'm aware of are covered by the code changes in this PR:

  • markdown tables MUST have headers
  • inline-html cannot be indented (and there's no {::nomarkdown} to get around it)
  • the anchor ID generation is slightly different leading to some links having to be updated

@swantzter swantzter added Area: Jekyll Related to how the site is generated Type: Enhancement Improve on already existing code, or elaborate more on the same concept labels Feb 14, 2022
@swantzter swantzter self-assigned this Feb 14, 2022
@swantzter
Copy link
Member Author

Currently breaking the {:toc} macro on the FAQ page. This is bad and needs to be solved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Jekyll Related to how the site is generated Type: Enhancement Improve on already existing code, or elaborate more on the same concept
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants