mktoc

Markdown Table of Content generator

Table of Contents

- About - Installation - Cargo - Binary - Usage - Update Markdown file - Inline config - Command line - Environment configuration - Auto-run with VSCode - Performance - Contributing - Where to start? - Tooling - Install dev build - License

About

⬆️ Back to Top

mktoc parses markdown files and generates a Table Of Content linking all headlines up to heading level 6 deep, or as specified by command line arguments, environment variables, or inline JSON config (see Usage).

Installation

⬆️ Back to Top

mktoc can be installed using Cargo, the Rust package manager.

Cargo

Installation sh $ cargo install mktoc

Update sh $ cargo install --force mktoc

Binary

Binaries are not available yet. If you know how releasing binaries with Rust can be implemented, please let me know!

Usage

Update Markdown file

⬆️ Back to Top

Add the following HTML comment into the Markdown file where the Table of Contents should be rendered.

html <!-- BEGIN mktoc --> <!-- END mktoc -->

Everything between those comments will be replaced!

Inline config

⬆️ Back to Top

Starting with version 3.0.0 it's possible to set values in-line which is great when collaborating with teams who may have individual settings.

```html

• About
• Installation
  • Cargo
  • Binary
• Usage
  • Update Markdown file
  • Inline config
  • Command line
  • Environment configuration
• Auto-run with VSCode
• Performance
• Contributing
  • Where to start?
  • Tooling
  • Install dev build
• License