A CLI package to extract and create a table of contents from markdown files.
Project description
extracttoc
Extract the table of contents from a markdown file with an easy to use command line tool.
Installation
pip install extracttoc
Usage
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
> 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
Limitations
The cli tool only works with hashtag-formatted headers, but not with equal-sign-formatted headers!
# This header will be recognized and included in the TOC
Some text paragraph.
This header will not be recongized.
===
Some text paragraph.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
extracttoc-0.3.3.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for extracttoc-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6516e8714824bf8466229f22e0a2033bfc53a0ae04474ef6e30cff4f7c788733 |
|
MD5 | 240cba1ac41a68f5406a04d2c87e55da |
|
BLAKE2b-256 | e3207a455ebd2583a33a860fabaa3f359b9ad3c318d3812e87c50c606860ab3c |