diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 18 insertions, 46 deletions
@@ -4,75 +4,47 @@  <!-- BEGIN mktoc --> -- [About](#about) -- [Installation](#installation) - - [Cargo](#cargo) - - [Binary](#binary) -- [Usage](#usage) - - [Update Markdown file](#update-markdown-file) + - [Command line](#command-line) + - [Environment configuration](#environment-configuration) - [Performance](#performance) - [License](#license) <!-- END mktoc --> - -## About - -`mktoc` parses markdown files and generates a Table Of Content linking all headlines up to heading level 6 deep, or as specified by command line arguments. A start depth and maximum depth can be specified. - -## Installation - -`mktoc` can be installed using Cargo, the Rust package manager. - -### Cargo - -```sh -$ cargo install mktoc -``` - -### Binary - -Binaries are actually not available yet. If you know how releasing binaries with Rust can be implemented, please let me know! - -## Usage - -### Update Markdown file - -Add the following HTML comment into the Markdown file where the Table of Contents should be rendered. -``` -<!-- BEGIN mktoc --> -<!-- END mktoc --> ``` Everything between those comments will be replaced! ### Command line -Specify `--write` to overwrite the given file, otherwise the modified content is written to stdout. +Specify `--stdout` or `-s` to output generated content to `stdout` instead of overwriting file. By default the specified file will be overwritten. ``` -# mktoc [--write] [--max-depth|-M] [--min-depth|-m] <FILE> -$ mktoc --write README.md -$ mktoc --write -m 2 -M 4 README.md +# 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 1.1.0 +mktoc USAGE: - mktoc [FLAGS] [OPTIONS] <file> +mktoc [FLAGS] [OPTIONS] [file] FLAGS: - -h, --help Prints help information - -V, --version Prints version information - -w, --write +-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 <max-depth> [default: 6] - -m, --min-depth <min-depth> [default: 1] +-M, --max-depth <max-depth> Maximum heading level [env: MKTOC_MAX_DEPTH=] [default: 6] +-m, --min-depth <min-depth> Minimum heading level [env: MKTOC_MIN_DEPTH=2] [default: 1] ARGS: - <file> +<file> [default: README.md] ``` ### Environment configuration @@ -92,7 +64,7 @@ Place these variables in a shell environment file such as `~/.bashrc` or # MKTOC_MIN_DEPTH=2 # MKTOC_MAX_DEPTH=4 -$ mktoc --write README.md +$ mktoc README.md ``` ## Performance |