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.
Usage
usage: extracttoc [-h] [-s] [-l LEVEL_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 table of contents to a md file. File name will be: {input-file-name}-toc.md
-l LEVEL_LIMIT, --levels LEVEL_LIMIT
Set the number of levels which will be included in the TOC.
Examples
> extracttoc myfile.md
> extracttoc -l 2 myfile.md # limit toc to level 2
> extracttoc -l 2 -s myfile.md # limit toc to level 2 and 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.2.tar.gz
(4.3 kB
view hashes)
Built Distribution
Close
Hashes for extracttoc-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b595b2fc3c0141d9a8ac3e3a9e640f88f4931bbae886f4096c6e47dfaf6910c |
|
MD5 | 1cc32ce5d585b0dc09d8dd9205c50d8d |
|
BLAKE2b-256 | f34f1b2d50da9fc525718cc0ed920038138044312db32059a849c9883bc73044 |