does not add anchors to headings using GitHub’s algorithm

[endiliey]

Subject of the issue

remark-slug does not add anchors to headings using GitHub’s algorithm.

This probably got to do with toString from https://github.com/syntax-tree/mdast-util-to-string

Your environment

N/A. Does not matter.

Steps to reproduce

Example you have markdown

## <a name="foo"></a> Foo

## <a name="foo"></a> _Foo_

Use runkit for easy reproduction

https://runkit.com/endiliey/5dd56d8045205a0013aec93d

Expected behaviour

Slug should be like GitHub https://gist.github.com/endiliey/4516bbf630b0f34eeabe8900733cfbf6#-foo

-foo and -foo-1

Actual behaviour

Slug is a-namefooa-foo and a-namefooa-foo-1

[wooorm]

We can’t do that easily, unfortunately, to solve it we’d need to include a whole HTML parser. That is a very intensive task.

If you’re going to HTML, instead, you can use rehype-slug.

Alternatively, you can set node.data.hProperties.id yourself, and bring that parser in if you want!

And lastly, you could also not use HTML in headings ;) HTML in Markdown has many downsides.

[wooorm]

Btw, thanks for distilling the problem down so much! That makes me able to answer quickly.

But on the other hand, maybe there is a bigger question you have, that I can also answer?

[endiliey]

Actually i don't mind with current behavior. Just opening up this issue just in case someone will open up an issue in our repo saying this.

When they do it, I will tell them to see this issue 😆

Thanks for the great work

[wooorm]

Ahh alright, good! Yeah, it’s good that this is documented 👍
If you have thoughts on how and where to add this to the docs, that’s also welcome!

Thanks Endi!