README.adoc in tocer-11.1.0 vs README.adoc in tocer-12.0.0

- old
+ new

@@ -43,41 +43,33 @@ == Usage === Command Line Interface (CLI) -From the command line, type: `+tocer --help+` +From the command line, run: `tocer --help` .... -tocer -c, [--config] # Manage gem configuration. -tocer -g, [--generate=PATH] # Generate table of contents. -tocer -h, [--help=COMMAND] # Show this message or get help for a command. -tocer -v, [--version] # Show gem version. -.... +USAGE: + -b, --build [PATH] Build table of contents. Default path: "." + -c, --config ACTION Manage gem configuration: edit or view. + -h, --help Show this message. + -v, --version Show gem version. -For specific `+--generate+` options, run `+tocer --help --generate+` to see the following: - +BUILD OPTIONS: + -i, --includes [a,b,c] Include pattern list. Default: ["README.md"]. + -l, --label [LABEL] Label. Default: "## Table of Contents". .... --l, [--label=LABEL] # Label - # Default: ## Table of Contents --i, [--includes=one two three] # File include list - # Default: ["README.md"] -.... To generate the table of contents at a specific position within your Markdown files, add the following lines to your file(s) prior to generation: [source,markdown] ---- <!-- Tocer[start] --> <!-- Tocer[finish] --> ---- -Alternatively, you can run `+tocer -g <directory>+` on files that do not have Tocer support and it -will prepend the table of contents to your file(s), complete with an auto-generated table of -contents. - In the case that Tocer has already auto-generated a table of contents for a Markdown file, the existing table of contents has become stale, or placement of the table of contents has changed you can re-run Tocer on that file to auto-update it with new table of contents. === Customization @@ -99,11 +91,11 @@ Feel free to take this default configuration, modify, and save as your own custom `configuration.yml`. The `configuration.yml` file can be configured as follows: -* `label`: The header label for the table of contents. Default: `"# Table of Contents"`. -* `includes`: The list of included files. Default: `"*.md"`. +* `label`: The header label for the table of contents. +* `includes`: The list of included files. There are multiple ways the include list can be defined. Here are some examples: [source,yaml] ----