mdi
English ｜ 中文
mdi(Markdown indexer) 是一个命令行工具，用于在目录下递归地生成 Markdown 索引。
安装
go install github.com/poneding/mdi@latest
使用
生成 Markdown 索引：
mdi gen
-d或--workdir：指定要生成 Markdown 索引的目录-t或--index-title：指定 Markdown 索引标题，默认为 Markdown 索引文件的一级标题或当前目录名-f或--root-index-file：指定输出 Markdown 根索引文件，默认为zz_gneratered_mdi.md--sub-index-file：指定输出 Markdown 子索引文件，默认为zz_gneratered_mdi.md--inherit-gitignore：使用.gitignore文件作为排除文件，默认为true--override：覆盖现有的 Markdown 索引文件，默认为false--no-header-link：在索引文件中不生成标题链接，默认为false-r或--recursive：递归在子目录中生成 Markdown 索引，默认为false--nav：在 Markdown 文件中生成导航，默认为false-v或--verbose：显示详细日志，默认为false
默认使用
.mdiignore文件作为排除文件。
其他命令：
# 打印版本
mdi version
# 打印帮助
mdi help
# 自动补全
mdi completion
# 示例:
# source <(mdi completion zsh)
截图
Markdown 文件结构：
生成 Markdown 索引：
mdi gen -f README.md -t "我的笔记"
同时，也会递归的在子目录下生成 Markdown 索引。
Markdown 文件生成导航：
mdi gen -f README.md -t "我的笔记" --nav
自定义子索引标题：
可以通过修改子目录中生成的 Markdown 索引文件的一级标题来自定义子索引标题。