remark-format-cli

remark-based CLI formatter for Markdown files, that generates table of contents.

• Source code: github.com/jceb/remark-format-cli
• Deno module: deno.land/x/remark_format_cli

Table of Contents

1. Usage
2. Install
3. Configuration
4. History

Usage

If you want to generate a table of contents in your markdown file, Add a heading called Contents before running the script. The table of contents will be added beneath the heading.

Format a Markdown file:

deno run --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.4.0/remark-format.js README.md

Or with the locally installed script:

remark-format README.md

Install

deno install --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.4.0/remark-format.js

Once installed, the local command remark-format will be available.

Configuration

Currently, there are no configuration or command line options. Hopefully, configuration options will be added in the future. For the moment, it’s very easy to customize the code directly in ./remark-format.js

History

There are many markdown table of contents generators. However, I haven’t found one yet that generates an ordered list and is well maintained. Furthermore, I’d very much prefer a simple, if possible non-existent, installation process.

With this in mind, I found remark-toc and opted for deno as a runtime since it recently added support for NPM modules. This combination made it very simple to create a custom remark CLI that integrates the remark-toc plugin.

TOC generators I’ve tried before:

• ycd/toc - works well but the installation is a bit of a struggle
• gh-md-toc - doesn’t support ordered tocs