Skip to content

项目中写readme的时候,想详细到每个文件,但是自己写又过于麻烦,这是可以自动生成的

shell
|-- undefined
    |-- .gitignore
    |-- home.png
    |-- logo.png
    |-- package-lock.json
    |-- package.json
    |-- README.md
    |-- .idea
    |   |-- .gitignore
    |   |-- modules.xml
    |   |-- notebook.iml
    |   |-- vcs.xml
    |   |-- watcherTasks.xml
    |   |-- workspace.xml
    |   |-- fileTemplates
    |       |-- markdown.md
    |-- docs
        |-- README.md

首先通过npm全局安装。

shell
npm install mddir -g

安装完毕,直接进入项目根目录,执行命令 mddir 即可在根目录下生成一个directoryList.md的文件。

如果需要在md文件中展示,需要前后包裹 ``` ,以便按格式显示。