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

Description List #135

Closed
ghost opened this issue Feb 18, 2019 · 1 comment
Closed

Description List #135

ghost opened this issue Feb 18, 2019 · 1 comment

Comments

@ghost
Copy link

ghost commented Feb 18, 2019

if you put this markdown on github.com:

one two
: three four five six

it gives you the expected output with github.io:

<dl>
  <dt>one two</dt>
  <dd>three four five six</dd>
</dl>

but not with github.com:

<p>one two
: three four five six</p>

this is because github.io uses KramDown by default, which supports
Description Lists:

https://kramdown.gettalong.org/syntax#definition-lists

while github.com uses GFM:

https://github.github.com/gfm

github.io can be configured to use CommonMarkGhPages which would give it the
same output as github.com. however that is not ideal because then both sites
would be producing the errant output. better would be if GFM supported
Description Lists as well. References:

@kivikakk
Copy link

kivikakk commented Feb 19, 2019

Support for description lists is not planned for GFM; if it lands in upstream CommonMark (per commonmark#281), then we will absorb it, but at this time no changes to the GFM extensions to CommonMark are being made.

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

1 participant