make-toc 1.2.3

A Shell script to automatically generate a Table of Contents from Markdown files.

Homepage: https://github.com/bkrem/make-toc.sh

Platform: npm

Language: Shell

License: MIT

Keywords: markdown, table, contents, shell, toc, table of contents, headers

View on registry: https://www.npmjs.com/package/make-toc

Direct download link: https://registry.npmjs.org/make-toc/-/make-toc-1.2.3.tgz

Install: npm install [email protected]


make-toc.sh

npm version Pull Requests Welcome

A Shell script to automatically generate a Table of Contents from Markdown files.

Contents

Installation

NPM

npm install -g make-toc

Manually

  1. Clone the repo or download as a ZIP and extract it.
  2. Add the markdown file you want to generate a ToC for to the project's folder.

Usage

NPM

make-toc ...opts source-file.md output-file.md

Manually

. ./make-toc.sh ...opts source-file.md output-file.md

Documentation

  • source-file.md - The markdown file a ToC should be generated for.
  • output-file.md - A filename to label the script's output, e.g. toc.md.

...opts

This section outlines flags for the script which may be used individually or in combination.

-s <n> or --skip <n>

Skips n headers from the top of the file.

For example, to omit the file's title header use:

make-toc -s 1 source.md target.md


-d <n> or --depth <n>

Sets the maximum depth for the table.

For example, to generate a fairly shallow table of the top-level and second-level headers only, use:

make-toc -d 2 source.md target.md

Passing -d 0 to the script will result in default behaviour, i.e. full depth.

Releases

1.2.3 January 11, 2017
1.2.2 January 11, 2017
1.2.1 December 21, 2016
1.2.0 December 15, 2016
1.1.8 October 02, 2016
1.1.7 October 02, 2016
1.1.6 September 30, 2016
1.1.5 September 25, 2016
1.1.5-docs September 25, 2016
1.1.4 September 21, 2016
See all 15 releases

Project Statistics

SourceRank 9
Dependencies 0
Dependent projects 0
Dependent repositories 0
Total releases 15
Latest release
First release
Stars 4
Forks 0
Watchers 2
Contributors 1
Repo Size: 117 KB

Top Contributors See all

Ben Kremer

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-01-11 20:43:13 UTC

Login to resync this project