Tocer (a.k.a. Table of Contenter) is a command line interface for generating table of contents for Markdown files. Use this tool to automatically manage and update your documentation with minimal effort. Works on single files or multiple files within nested directory structures.
Supports Markdown ATX-style headers. Example:
Does not support header suffixes. Example:
# Header #.
Does not support header prefixes without spaces. Example:
Supports table of contents generation for single or multiple files.
Supports custom label. Default:
## Table of Contents.
Supports file list filtering. Default:
Prepends table of contents to Markdown documents that don’t have table of contents.
Rebuilds Markdown documents that have existing table of contents.
A UNIX-based system.
To install, run:
gem install tocer
Command Line Interface (CLI)
From the command line, run:
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. BUILD OPTIONS: -i, --includes [a,b,c] Include pattern list. Default: ["README.md"]. -l, --label [LABEL] 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:
<!-- 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.
This gem can be configured via a global configuration:
It can also be configured via XDG environment variables.
The default configuration is as follows:
:label: "## Table of Contents" :includes: - "README.md"
Feel free to take this default configuration, modify, and save as your own custom
configuration.yml file can be configured as follows:
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:
# Use an empty array to ignore all files (a key with no value would work too). :includes:  # Use an array of wildcards for groups of files with similar extensions: :includes: - "*.md" - "*.mkd" - "*.markdown" # Use a mix of wild cards and relative names/paths to customized as necessary: :includes: - "README.md" - "docs/*.md" - "*.markdown" # Use a recursive glob to traverse and update all sub-directories: :includes: - "**/*.md"
You can add Rake support by adding the following to your
begin require "tocer/rake/setup" rescue LoadError => error puts error.message end
Once configured, the following tasks will be available (i.e.
bundle exec rake -T):
rake toc[label,includes] # Add/Update Table of Contents (README)
…which can be called as follows (quotes are not necessary if spaces are not used):
rake toc["## Example, *.md"]
To contribute, run:
git clone https://github.com/bkuhlmann/tocer.git cd tocer bin/setup
You can also use the IRB console for direct access to all objects:
To test, run:
bundle exec rake
Read Semantic Versioning for details. Briefly, it means:
Major (X.y.z) - Incremented for any backwards incompatible public API changes.
Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
Code of Conduct
Read Code of Conduct for details.
Read Contributions for details.
Read License for details.
Read Changes for details.
Engineered by Brooke Kuhlmann.