flybook icon indicating copy to clipboard operation
flybook copied to clipboard

Supports a table of contents

Open sculove opened this issue 7 years ago • 1 comments

you can create a table of contents using headline title like this

file A.md

## title
### title1
### title2

a table of contents

A

  • title
    • title1
    • title2

How about supporting a table of contents?

sculove avatar Jun 28 '17 15:06 sculove

I agree that TOC would be a great component for writing markdown document. There might be some points to consider before putting it into flybook as a feature.

  • There are some independent TOC builders already in form of package, plugin or extension.
  • TOC itself doesn't seem like a markdown standard kinda thing.
  • GFM - the most popular markdown language among developers - doesn't support TOC component as a markdown language.
  • There's no standardized TOC implementation(design), which means if flybook implements the way to create TOC block it will be flybook-original design.

All concerns above are not the critical reasons flybook shouldn't have TOC feature, but just throwing points to consider whether we go or not.

djkeh avatar Jul 19 '17 07:07 djkeh