mdi

English 中文

mdi(Markdown indexer) is a command line tool used to recursively generate markdown indexes in directories.

Installation

go install github.com/poneding/mdi@latest

Usage

Generate markdown index:

mdi gen

Use .mdiignore file as ignore file by default.

Other commands:

# Print version
mdi version

# Print help
mdi help

# Auto Complete
mdi completion
# Example:
# source <(mdi completion zsh)

Screenshots

Markdown folder:

20231124165206

Generate markdown index

mdi gen -f README.md -t "My Notes"

20231124170746

As the same time, the index file will be generated in the subdirectory recursively.

Generate nav in markdown file:

mdi gen -f README.md -t "My Notes" --nav

20231124170902

Customize sub index title:

You can customize the sub index title by modifying the first-level title of the sub markdown index file generated in the subdirectory.