Metadata-Version: 2.1
Name: tocinator
Version: 1.0.1
Summary: Generate a Table of Content from Markdown files.
Home-page: https://github.com/Coder-RG/tocinator
Author: Rishabh Goel
Author-email: rgoel1999@gmail.com
License: UNKNOWN
Description: # TOCinator
        
        [![MIT license](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) [![Py version](https://img.shields.io/pypi/pyversions/tocinator)](https://pypi.org/project/tocinator/1.0.0/) [![GitHub tag](https://img.shields.io/github/tag/Coder-RG/tocinator.svg)](https://GitHub.com/Coder-RG/tocinator/tags/)
        
        This python module parses your Markdown file and generates a Table of Content(TOC)
        for that file. It should be noted that this is still in development and may not
        always function as expected.
        
        **The TOC below was completely generated using this module.**
        
        ## Table of Content
        1. [Features of this module](#features-of-this-module)
        2. [Code Generated using tocinator](#code-generated-using-tocinator)
        3. [Rendered Code](#rendered-code)
        4. [How to use this module](#how-to-use-this-module)
           1. [What not to do](#what-not-to-do)
        5. [General Layout](#general-layout)
        
        ## Features of this module
        1. Generate Markdown-ready code.
        2. Generated TOC has links to the actual headings and subheading. Which means you
        can just paste the generated code in you README file and click on any of the links
        to go to the desired heading.
        
        ## Code Generated using tocinator
        Below is an example of TOC generated using tocinator.
        The README used in the below snippets is from my [other][1] repository.
        Do check it out if you code in C, it might be of your interest.
        ![Code](https://raw.githubusercontent.com/Coder-RG/tocinator/master/images/ss1.png)
        
        ## Rendered Code
        ![Render](https://raw.githubusercontent.com/Coder-RG/tocinator/master/images/ss2.png)
        
        ## How to use this module
        1. Use `##` for headings
        2. Use `###` for subheadings.
        
        **With pip**
        ```bash
        $ pip install tocinator
        ```
        
        **Without pip**
        3. Clone this repo.
        4. Change directory to cloned repo.
        ```bash
        $ cd tocinator
        ```
        5. Run the file at command line:
        ```bash
        $ python3 src/tocinator/tocinator.py <input-file> <output-file>
        ```
        **Example 1: (if installed using pip)**
        ```bash
        $ python3 -m tocinator README.md OUT.md
        ```
        
        **Example 2: (if not installed with pip)**
        ```bash
        $ python3 src/tocinator/tocinator.py README.md OUT.md
        ```
        
        If the .md file is in another folder, then use absolute path.
        ```bash
        $ python3 src/tocinator/tocinator.py <path-to-folder>/README.md <path-to-folder>/TEST.md
        ```
        
        **Example 3:**
        ```bash
        $ python3 sr/tocinator/tocinator.py /home/username/project/README.md /home/username/project/OUT.md
        ```
        ### What not to do
        1. `#` and `####` are not used in the parsing yet and therefore won't be
        displayed in the TOC.
        2. Only use alphanumeric for heading and subheadings. Otherwise, the links won't work.
        
        ## General Layout
        ![Code](https://raw.githubusercontent.com/Coder-RG/tocinator/master/images/ss4.png)
        
        ![Render](https://raw.githubusercontent.com/Coder-RG/tocinator/master/images/ss3.png)
        
        Code is rendered using grip module. Do check out [grip][2] if you want to render your markdown files in your browser.
        
        [1]: https://github.com/Coder-RG/compc
        [2]: https://pypi.org/project/grip/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
