mdtoc

• crates.io

mdtoc，即 markdown table of contents，为 Markdown 文档创建目录。

Markdown 目录非常有用，因为它除了提供文档概览外，还允许你轻松地在标题之间跳转！例如，尝试这个 链接，它将带你到这个 README 的 TODO 部分。

目录

1. mdtoc
   1. 概览
   2. 演示
   3. TODO

概览

~
  $ mdtoc --help
mdtoc 0.2.0
Jack <[email protected]>
generate table of contents for markdown

USAGE:
    mdtoc [OPTIONS] <file>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -b, --bullet <bullet>    Bullet to use for the lists, for example '*', '-', '1.' [default: 1.]
    -t, --indent <indent>    Number of space character, ' ', to use to represent a single indent [default: 4]

ARGS:
    <file>    Markdown file to read

演示

~
  $ cat in.md
# README

## tWo 1

### tHReE 1

## TWo 2

~
  $ mdtoc in.md
## Table of Contents

1. [README](#readme)
    1. [tWo 1](#two-1)
        1. [tHReE 1](#three-1)
    1. [TWo 2](#two-2)

TODO

1. 输出包含插入目录的原始 md 文件吗？