README.adoc in tocer-12.2.0 vs README.adoc in tocer-13.0.0

- old
+ new

@@ -48,18 +48,18 @@ From the command line, run: `tocer --help` .... USAGE: - -b, --build [PATH] Build table of contents. Default path: "." -c, --config ACTION Manage gem configuration: edit or view. -h, --help Show this message. + -i, --insert [PATH] Insert/update table of contents. Default: ".". -v, --version Show gem version. -BUILD OPTIONS: - -i, --includes [a,b,c] Include pattern list. Default: ["README.md"]. - -l, --label [LABEL] Label. Default: "## Table of Contents". +OPTIONS: + --includes [a,b,c] Add include patterns. Default: ["README.md"]. + --label [LABEL] Add label. Default: "## Table of Contents". .... 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: @@ -67,13 +67,13 @@ ---- <!-- Tocer[start] --> <!-- Tocer[finish] --> ---- -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. +In the case that Tocer has 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 This gem can be configured via a global configuration: `~/.config/tocer/configuration.yml`. @@ -85,25 +85,27 @@ [source,yaml] ---- :label: "## Table of Contents" :includes: - "README.md" +:root_dir: "." ---- 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. * `includes`: The list of included files. +* `root_dir`: The root path to use for processing files. There are multiple ways the include list can be defined. Here are some examples: [source,yaml] ---- -# Use an empty array to ignore all files (a key with no value would work too). +# Use an empty array to ignore all files: :includes: [] # Use an array of wildcards for groups of files with similar extensions: :includes: - "*.md" @@ -198,12 +200,13 @@ == License Read link:LICENSE.adoc[LICENSE] for details. -== History +== Changes Read link:CHANGES.adoc[CHANGES] for details. == Credits -Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann]. +* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith]. +* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].