Table of Contents when conversion??

bylexus / grunt-md2html

Small Grunt MultiTask to convert Markdown files to HTML, supporting Grunt >= 1.0.0

MIT License

37 stars 5 forks source link

Table of Contents when conversion?? #7

Open adamrossmusic opened 8 years ago

adamrossmusic commented 8 years ago

Hi guys!

Recently i am using your great grunt plugin for markdown conversion for a documentation app. I found out it is not possible to generate the table of contents with your md2html plugin, which would be extremely useful, with other plugins it is quite messy and not so easy to implement.

Any chances for TOC generation in the future?

Greetz,

Adam

bylexus commented 8 years ago

Dear Adam,

Generating a TOC is a not a straight-forward thing to do: Of course we could take every heading found in the MD files, but is this really what the user wanted?

So we must find a way to configure things like TOC depth, html generation (e.g. how do we output the TOC, is it an UL list, or something else?), template placement.

So to come back to your question: Yes, this would be a nice feature, but not trivial to implement. I will put it on the feature list for the future.