获得 markdown 无序列表格式的文件目录树

tree 命令可以获得文件目录结构,但是放在文档中时,我想用 markdown 无序列表的形式,在编辑器内还可以折叠。

完整解决方案:在 ~/.oh-my-zsh/custom 下添加下述自定义函数(这里只是为了方便创建了函数,如果一次性使用的话直接调用命令即可)

tree-markdown() {
    echo "🚩 generate tree of $@ in markdown format"
    local trees=$(tree -av --dirsfirst --noreport  --charset ascii $@ |
        sed -e 's/| \+/  /g' \
            -e 's/[|`]-\+/ -/g' \
            -e 's/- \(.*\)/- `\1`/g')
    echo ${trees}
}

解释:

  1. tree 命令获得指定格式的文件结构,列出所有文件,文件夹优先,字母顺序排列
  2. 使用 sed 命令替换标记为 markdown 的 -, 并且把文件名放在 `` 内部(文件名会和链接混淆)

参考资料:
markdown - Is there a way to represent a directory tree in a Github README.md? - Stack Overflow

posted @ 2023-06-26 00:28  BuckyI  阅读(99)  评论(2编辑  收藏  举报