mktoc

Markdown Table of Content generator

- Command line - Environment configuration - Performance - License ```

Everything between those comments will be replaced!

Command line

Specify --stdout or -s to output generated content to stdout instead of overwriting file. By default the specified file will be overwritten.

```

mktoc [FLAGS] [OPTIONS] [file]

$ mktoc -s README.md $ mktoc -m 2 -M 4 README.md $ mktoc ``` If no arguments are given the default or configured (via environment) values are used.

See mktoc --help for list of all arguments and flags.

``` mktoc

USAGE: mktoc [FLAGS] [OPTIONS] [file]

FLAGS: -h, --help Prints help information -s, --stdout If set will output to stdout instead of replacing content in file -V, --version Prints version information

OPTIONS: -M, --max-depth Maximum heading level [env: MKTOCMAXDEPTH=] [default: 6] -m, --min-depth Minimum heading level [env: MKTOCMINDEPTH=2] [default: 1]

ARGS: [default: README.md] ```

Environment configuration

mktoc can be configured with environment variables, namely:

• MKTOC_MIN_DEPTH equal to -m
• MKTOC_MAX_DEPTH equal to -M

Place these variables in a shell environment file such as ~/.bashrc or ~/.zshrc, then just run mktoc without -m and -M

```sh

The following in ~/.bashrc configures mktoc to render headings from level 2 to

level 4

MKTOCMINDEPTH=2

MKTOCMAXDEPTH=4

$ mktoc README.md ```

Performance

mktoc is fast but can probably be even faster! Pull Requests and bug reports are appreciated!

License

MIT, see LICENSE file.