Giter VIP home page Giter VIP logo

xmp-er / markdown-index Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 92 KB

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.

Home Page: https://markdownindexgenerator.netlify.app/

License: MIT License

HTML 43.67% JavaScript 56.33%
markdown markdown-editor markdown-index markdown-toc markdown-index-generator markdown-toc-generator

markdown-index's Introduction

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

markdown-index's People

Contributors

xmp-er avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.