Skip to content

Generates entire content with a TOC for all the headings and adds a link to TOC after each content heading,even lets you upload local markdown files and generates index for it.

License

Notifications You must be signed in to change notification settings

xmp-er/Markdown-index

Repository files navigation

Access site at Markdown TOC(Table Of Contents)/Index Generator

Index

Purpose:-

Index

Often times while taking notes on markdown files it becomes tiresome to make a TOC when you have a large amount of headings and sub-headings,this site aims to solve this by

  • Automatically Generating TOC(Table Of Contents) and inserting it into the beginning of the content
  • Adding link to main index after each heading and sub-heading for easier navigation
  • Lets you upload local markdown files and generates a Table Of Contents for it automatically

Demonstration images:-

Index

image

image

Precautions for Heading so that Index can be properly generated:-

Index

  • NOTE that it only works when headings are of the type "#","##" etc.
  • Special character in between two words in heading will not work (Ex:-Date & Time)

Upcoming Updates

Index

  • UI updates
  • Extract markdown code from a Github link and generate index/TOC for it.
  • Redirect feature to immediate parent heading along with index redirect.
  • parsing of html tags along with hashes in the heading

Fixes

Index

  • Fix for Recursive Heading not being properly generated

About

Generates entire content with a TOC for all the headings and adds a link to TOC after each content heading,even lets you upload local markdown files and generates index for it.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published