remark-format-cli
remark-based CLI formatter for Markdown files, including table of contents genreation.
- Source code: github.com/jceb/remark-format-cli
- Deno module: deno.land/x/remark_format_cli
Contents
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 --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.0.8/remark-format.js README.md
Or with the locally installed script:
remark-format README.md
Install
deno install --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.0.8/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: