#markdown #generate-markdown #content #catalog #md #file #title

bin+lib catalog-of-markdown

Generate the catalog of markdown file

7 releases

0.1.6 Nov 15, 2024
0.1.5 Nov 15, 2024
0.1.4 Aug 28, 2023
0.1.3 Apr 7, 2023
0.1.1 Jan 4, 2022

#394 in Text processing

Download history 2/week @ 2024-09-20 2/week @ 2024-10-11 1/week @ 2024-11-01 1/week @ 2024-11-08 230/week @ 2024-11-15 11/week @ 2024-11-22 1/week @ 2024-12-06

242 downloads per month

MIT license

11KB
245 lines

README

Generate catalog of README.md on Github Repo.

Install

cargo install catalog-of-markdown

Usage

Example

cargo run -- Example.md

will generate content below in stdout:

- [Example](#example)
  - [Subtitle0](#subtitle0)
    - [sub sub title](#sub-sub-title)
  - [Subtitle 1](#subtitle-1)
  - [Subtitle 2](#subtitle-2)

cargo run -- -d 1 ./Example.md

- [Subtitle0](#subtitle0)
  - [sub sub title](#sub-sub-title)
- [Subtitle 1](#subtitle-1)
- [Subtitle 2](#subtitle-2)

cargo run -- -d 2 ./Example.md

- [sub sub title](#sub-sub-title)

cargo run -- -s "*" ./Example.md

* [Example](#example)
  * [Subtitle0](#subtitle0)
    * [sub sub title](#sub-sub-title)
  * [Subtitle 1](#subtitle-1)
  * [Subtitle 2](#subtitle-2)

Dependencies

~3.5–5MB
~86K SLoC