Document how header slugs get generated

[jedwards1211]

I have headers in my repo https://github.com/vscodeshift/material-ui-snippets like

### `mui-app-bar-menu`: <AppBar> with menu icon

The slug GitHub generates for this is

#mui-app-bar-menu-appbar-with-menu-icon

But many libs like github-slugger and markdown-toc don't currently strip away HTML entities, instead generating

#mui-app-bar-menu-ltappbargt-with-menu-icon

I PRed a fix to both these libs, but this points to the need for a concrete specification of what GitHub is doing, so that we can guarantee correct output in tools like these.

[UziTech]

@zeke wondering if you ever got an answer for Flet/github-slugger#25 (comment)

[zeke]

Sorry, I don't remember. 🤔

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.