Consider Mentioning Existence of GitHub's Built-In Markdown Table of Contents

[Kurt-von-Laven]

Slightly over a year ago, GitHub added TOC as a first-class feature, so it may be worth explicitly clarifying md-toc's value proposition in its README. Some examples that come to mind for me:

• Markdown can be rendered in many contexts, such as a blog, regardless of whether the source is hosted on GitHub.
• Even when using Markdown purely for READMEs and community health files, there may be other cloud-hosting platforms that do not offer first-class TOC support, and even if you use GitHub, a mirror may not.
• Even on GitHub, many users may not spot the small TOC icon.
• Some people prefer to render and view Markdown locally.
• It's convenient to have a TOC while editing the Markdown source since editors can correctly navigate the links locally.

Some users may only use md-toc because they are unaware of GitHub's analogous built-in feature, but personally I don't see many folks abandoning the tool for this reason alone in light of the examples above as well as its ease-of-use, simplicity, reliability, and performance.

[frnmst]

I added a section in the documentation a while ago, but not in the main readme so it's not really visible. See https://docs.franco.net.eu.org/md-toc/markdown_specification.html#curiosities

I know what you mean: i use md-toc myself for my blog. I will change the README to reflect the point you illustrated.

Thank you for the tips!

[frnmst]

Maybe making something like a comparison table would be useful. See for ex. Gitea's one

[Kurt-von-Laven]

Looks like you were one step ahead of me. Ha ha, comparison tables are many marketing departments' favorite thing.