Repository navigation
[GFM] wrong ID generation for headers containing -- #459
Description
Consider the following fragment of an .md file on github:
...
see [--foobar](#option---foobar) option below.
...
## Option --foobarThe above gets rendered by GitHub to the following:
...
see --foobar option below.
...
Option --foobar
Now, if we use kramdown GFM to convert this .md, we'll have the following two problems:
- Double dash gets replaced by ndash, which is bad at least in this particular case, and maybe in general, as GitHub's own parser doesn't do it.
- The link to "Option --foobar" will not work, as ID for the intralink will be
option-foobarrather than github'soption---foobar. The reason is the above double-dash -> ndash conversion.
While the first issue is only bad in some specific cases, the second one is really bad as it breaks some intralinks in the resulting document. Perhaps it makes sense to disable double-dash and triple-dash conversion for GFM (say, another option to gfm_quirks)?
Activity
gettalong commentedon Oct 11, 2017
If we change the way link generation works for the GFM parser, it might break existing documents. However, since it is GFM we are talking about and the implementation in kramdown is not quite complete, I would consider such a change a bug fix and not a feature change.
A pull request for this is welcome.
GFM parser: disable typographic symbol conversion
GFM parser: no default typographic symbol conversion
kolyshkin commentedon Oct 17, 2017
OK, I have a PR with a patch that apparently works. I'm just not sure about it as my Ruby knowledge is totally non-existent, to say at least.
GFM parser: no default typographic symbol conversion
GFM parser: quirk to disable auto typographic symbol conversion
gettalong commentedon Oct 26, 2017
Pull request #462 is applied.
GFM parser: quirk to disable auto typographic symbol conversion
Bump kramdown 💎 to 1.16.2