w3c / scribejs

Converter of RRSAgent IRC logs into minutes in markdown
https://w3c.github.io/scribejs/BrowserView/
Other
11 stars 14 forks source link

Fix header anchor links #63

Closed BigBlueHat closed 5 years ago

BigBlueHat commented 5 years ago

GFM and CommonMark do not (yet?) support custom identifier creation, so we have to depend on their auto-id generation systems. This code now properly takes that into account and generates correct fragment ID links for ToC, etc.

Sadly, due to this lack in GFM/CommonMark, resolution and action summaries cannot link back to the moment they were resolved. So, if you want that, use Kramdown.

Fixes #59

iherman commented 5 years ago

@BigBlueHat I do not understand what you mean by

GFM and CommonMark do not (yet?) support custom identifier creation

At the moment, the script follows the

  # [Header text](id:someanchorname)

idiom for the non-kramdown case to turn the header into anchors. What is the problem with this? What is the problem this PR tries to solve?

BigBlueHat commented 5 years ago

It's not a supported idiom. I've found it in CommonMark or GFM, and it doesn't work on GitHub.

Where did you find that format in use?

iherman commented 5 years ago

Hm. I could swear I did use it somewhere, but maybe I did not check it properly on github:-(

If this is the issue you settle in the PR, then go ahead and merge it!

BigBlueHat commented 5 years ago

@iherman k. Sounds good. If you find a place where that format works, I'm more than happy to do the work to put it back! 😄