Metadata-Version: 2.1
Name: extracttoc
Version: 0.4.0
Summary: A CLI package to extract and create a table of contents from markdown files.
Home-page: https://github.com/CribberSix/markdown-toc-extract
Author: CribberSix
Author-email: cribbersix@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: regex
Requires-Dist: clipboard

# extracttoc

[![PyPi](https://img.shields.io/pypi/v/extracttoc?color=blue&style=plastic)](https://pypi.org/project/extracttoc/)
![License](https://img.shields.io/github/license/Cribbersix/markdown-toc-extract?style=plastic)
[![CodeFactor](https://www.codefactor.io/repository/github/cribbersix/markdown-toc-extract/badge?style=plastic)](https://www.codefactor.io/repository/github/cribbersix/markdown-toc-extract)
![Repository size](https://img.shields.io/github/repo-size/Cribbersix/markdown-toc-extract?style=plastic)
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg?style=plastic)](https://www.python.org/)

Extract the table of contents from a markdown file with an easy to use command line tool written in Python.

## Installation

```sh
pip install extracttoc
```

## Usage


```sh
usage: extracttoc [-h] [-s] [-c] [-i] [-l LIMIT] file

Extracts the table of contents from a markdown file.

positional arguments:
  file                  Provide a markdown file from which to extract the toc.

optional arguments:
  -h, --help            show this help message and exit
  -s, --save            Write the TOC to a md file. File name will be: {input-file-name}-toc.md
  -c, --copy            Copy the TOC to your clipboard
  -i, --insert          Insert the TOC directly into the file in front of the first line.
  -l LIMIT, --levels LIMIT
                        Set the number of levels which will be included in the TOC.
```

## Examples

```python
> extracttoc myfile.md  # displays the TOC

> extracttoc -c myfile.md  # display & copy TOC to clipboard

> extracttoc -l 2 myfile.md  # limit TOC to header level 2

> extracttoc -l 2 -s myfile.md  # limit TOC to lvl 2 & write to separate file
```


