Improve GitHub Flavored Markdown Docs#8684
Conversation
@check-spelling-bot ReportUnrecognized words, please review:
To accept these unrecognized words as correct, run the following commands... in a clone of the git@github.com:mkasberg/jekyll.git repository If you see a bunch of garbageIf it relates to a ... well-formed patternSee if there's a pattern that would match it. If not, try writing one and adding it to the Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines. Note that patterns can't match multiline strings. binary-ish stringPlease add a file path to the File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
|
@check-spelling-bot ReportUnrecognized words, please review:
To accept these unrecognized words as correct, run the following commands... in a clone of the git@github.com:mkasberg/jekyll.git repository If you see a bunch of garbageIf it relates to a ... well-formed patternSee if there's a pattern that would match it. If not, try writing one and adding it to the Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines. Note that patterns can't match multiline strings. binary-ish stringPlease add a file path to the File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
|
I recently merged jekyll#8681 to improve the Jekyll docs for markdown options. While researching that, I noted that the `kramdown-parser-gfm` gem is required by default in Jekyll, but I didn't dig further as to why. After jekyll#8681 merged, I was curious about why `kramdown-parser-gfm` is required by default, and I followed up on digging into it. As it turns out, this GFM parser is required by default because Jekyll uses GFM by default. This is clear from the [default config docs](https://jekyllrb.com/docs/configuration/default/) and the code: https://github.com/jekyll/jekyll/blob/76517175e700d80706c9139989053f1c53d9b956/lib/jekyll/configuration.rb#L67-L72 Although this is outlined in the default configuration docs, other parts of the docs don't do a good job making it clear that GFM is actually the default behavior. My recent docs change in jekyll#8681 made this problem worse since I used a bunch of config in my examples that's actually just default config. In this PR, I'm addressing that problem by modifying my update to the Markdown Options docs to clearly note that GFM is the default parser. I'm also updating a tutorial that implied GFM isn't the default. I've searched this repo for "GFM" and I'm pretty confident I've found all the problematic docs.
|
@jekyll: merge +docs |
Mike Kasberg: Improve GitHub Flavored Markdown Docs (#8684) Merge pull request 8684
This is a 🔦 documentation change.
Summary
I recently merged #8681 to improve the Jekyll docs for markdown options.
While researching that, I noted that the
kramdown-parser-gfmgem isrequired by default in Jekyll, but I didn't dig further as to why.
After #8681 merged, I was curious about why
kramdown-parser-gfmisrequired by default, and I followed up on digging into it. As it turns
out, this GFM parser is required by default because Jekyll uses GFM by
default. This is clear from the default config
docs and the code:
jekyll/lib/jekyll/configuration.rb
Lines 67 to 72 in 7651717
Although this is outlined in the default configuration docs, other parts
of the docs don't do a good job making it clear that GFM is actually the
default behavior. My recent docs change in #8681 made this problem worse
since I used a bunch of config in my examples that's actually just
default config.
In this PR, I'm addressing that problem by modifying my update to the
Markdown Options docs to clearly note that GFM is the default parser.
I'm also updating a tutorial that implied GFM isn't the default. I've
searched this repo for "GFM" and I'm pretty confident I've found all the
problematic docs.
Context
This follows up on #8681, which was originally created in response to #8593.