https://github.com/robertofd1995/toc-index-markdown-generator

This program will search for all the markdown files and subfolders in a folder and it will create an index
https://github.com/robertofd1995/toc-index-markdown-generator

markdown markdown-parser python3 toc-generator

Last synced: 3 months ago
JSON representation

This program will search for all the markdown files and subfolders in a folder and it will create an index

• Host: GitHub
• URL: https://github.com/robertofd1995/toc-index-markdown-generator
• Owner: robertofd1995
• License: osl-3.0
• Created: 2017-08-19T22:30:26.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-27T14:12:26.000Z (over 8 years ago)
• Last Synced: 2023-03-09T02:23:01.847Z (over 3 years ago)
• Topics: markdown, markdown-parser, python3, toc-generator
• Language: Python
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          

# For what is this program ?

This program will search for all the markdown files and subfolders in a folder and it will create an index

Example of directory :

    Book

    - README.md

        Chapter_1

        - part_1.md

        - part_1_2.md

        Chapter 2

        - part_2.md

            Chapter2_1

            - part2_2.md

OutPut :  (index.md)

    #Book

    * README.md

    ## Chapter_1

    * part_1.md

    * part_1_2.md

    ## Chapter_2

    * part_2.md

    ### Chapter2_1

    * part2_2.md

## How to use

To use just change the route to point to the directory on the script and execute the program

## Warning

All folders and files cannot contain white spaces , if so the index file will need to be fixed manually