Skip to content

Support for TOC in README files

It seems this was something which was supported in the past, but with recent migrations to a different markdown rendering engine it is not anymore. So I am opening an issue to point to this again.


Updated description with a now working example

Supporting Table of Contents

Does this seem like something we should support? And allow in issue descriptions?

Syntax

Let use the [[_TOC_]] syntax for now

Other options

If CommonMark ever officially supports something, we'll add that

How do we know it is done?

When an auto-generated table of contents appears above

Edited by Brett Walker