mddir自动生成文件目录结构工具

emo王子

已于 2022-04-05 21:27:29 修改

阅读量2.5k

点赞数 2

文章标签：前端 javascript

于 2022-04-05 21:26:34 首次发布

本文链接：https://blog.youkuaiyun.com/aaaaaaaa_ewf/article/details/123977624

版权

本文介绍了如何通过mddir工具快速生成Markdown目录，演示了从安装到使用的全过程，并展示了其生成的directoryList.md文件结构。这对于整理项目文档和README.md内容非常实用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、什么是mddir？

在平时写博客或者记录一个项目的时候，总是会先梳理一下项目基本机构，也就是希望展示如下所示图形

之前都是手写，很累，偶然发现一个工具可以基于项目目录结构动态生成目录机构md文件，所以特此记录一下，这个工具的使用方法。

2、安装mddir

mac安装需求权限
    sodu npm install mddir -g

windows安装
    npm install mddir -g

3、使用

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

4、生成的 directoryList.md

5、复制放到README.md

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

emo王子

关注关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Markdown语法：利用mddir工具自动生成文件目录结构

看门猫的博客

03-17

6524

Markdown语法：利用mddir工具自动生成文件目录结构前言安装mddir工具使用mddir工具前言 mddir是个能帮助我们快速生成markdown语法形式的文件目录结构的工具，详细说明请参考官方文档https://www.npmjs.com/package/mddir 安装mddir工具要安装mddir工具，必须先安装npm包管理工具。我的npm包管理工具是在安装node时自动安装的，...

md文件生成项目目录树

liuqiao0327的专栏

07-05

4615

参与评论您还未登录，请先登录后发表或查看评论

目录结构生成器

10-15

扫描生成目录结构，方便好用扫描生成目录结构，方便好用扫描生成目录结构，方便好用

目录结构生成器，小工具

09-25

想把光盘里的文件目录统计出来，在优快云找到了类似的资源但是不是 Release 版本的，害得我白白浪费一分，就自己写了一个！选择你需要统计的目录，选择文件存放路径，就会生成指定目录对应的目录及文件的结构的文本文档。

文件夹目录树自动生成工具

最新发布

gitblog_06797的博客

04-21

468

文件夹目录树自动生成工具【下载地址】文件夹目录树自动生成工具这款文件夹目录树自动生成工具能够快速生成当前目录及其子目录下所有文件的详细列表，支持Excel和TXT两种格式输出。生成的Excel文件附带超链接功能，点击即可直接打开对应文件，省去繁琐的查找步骤。工具操作简单，只需运行即可自动完成目录树的生成，极大提升了文...

自动化文件目录结构生成工具——filemap.js

weixin_34279246的博客

07-14

683

项目地址：https://github.com/jrainlau/filemap开发环境node版本为5.4.1 简介作为一个经常写博客的人，在介绍自己的项目的时候往往需要介绍文件目录结构。在以往的情况下，要么一行一行手动码字输入，要么简单粗暴地截图，都无法方便快速地构造一个文件目录结构图出来。后来在学习算法的时候，发现文件目录结构跟...

项目展示必备！目录树一键生成工具（目录结构生成器）

XiaoqiangClub的博客

09-20

2224

项目展示必备！目录树一键生成工具（目录结构生成器）

mddir生成结构目录.bat

04-24

项目使用markdown来编辑项目信息介绍，该脚本使用开源工具 mddir 生成项目文件目录结构图，使用该脚本需要安装node

代码目录结构怎么生成

12-27

对于希望自动化生成项目代码目录结构的需求，存在多种方法和工具可供选择。 #### 使用命令行工具 `tree` `tree` 是一个简单而有效的命令行工具，能够直观地显示文件夹下的子文件夹以及文件。在 Linux 和 macOS 中...

Markdown生成代码目录

James_bobo的博客

05-10

1078

前端工程化工具系列（九）—— mddir(v1.1.1)：自动生成文件目录结构工具

天下布武

06-06

605

是一个基于项目目录结构动态生成 Markdown 格式目录结构的工具，方便开发者在文档中展示文件和文件夹的组织结构。

自动打包生成目录结构工具

07-03

根据文件path列表，自动生成包含的path文件路径，用于项目增量打包非常方便，自动创建目录结构。

文件夹及文件的目录生成器

02-19

文件夹及文件的目录生成器，能主动生成本文件夹内所有文件的目录的EXCEL表

电脑文件目录自动生成器

06-15

直接双击运行，完毕后窗口自动关闭，并在当前目录下生产文件目录树形表的txt文件，支持CDEF4个盘符，个人感觉很好的

硬盘文件目录生成器.

04-27

生成硬盘电影目录专用，可将选定的所有目录下的文件和文件夹顺序生成含链接的Html文件，文件越多排序时间越长，请耐心等待。使用时须注意下列事项： 1.生成目录名为“目录Catalogue.html”，不可以自定义，所选择目录数量最多为7个，因业余时间少，待完善。 2.生成目录时，注意确认所选择路径不存在“目录Catalogue.html”文件，否则无法保存新生成的目录文件。 3.杀毒软件会误报，请自行解决。 4.本人是按键精灵的业余的业余爱好者，开发本脚本只是自用，与大家分享，不可能适合所有人的需要，有问题联系

treer:生成目录结构小工具

天黑不熄灯

03-21

1751

文章目录安装方法安装方法 npm install treer -g //全局安装treer，如果只想安装在当前目录可以去掉-g

mddir--生成文件目录小工具

weixin_59297032的博客

01-20

453

做项目交接和开发文档时，需要梳理项目结构目录，类似于：手动编写。。。。会吐血。。。所以推荐使用mddir。

文件目录结构生成器

leafy的博客

11-18

3019

将以下文件复制到一个文本文件中，保存为批处理文件的后缀，双击运行即可。 title 指定命令提示窗口的标题 echo off cls echo Please enter the specific folder path ( For instance: Directory=C:\ ), and then choose "save as" to save the fi

使用mddir生成项目的工程结构

weixin_45547638的博客

10-13

452

1、先全局安装插件 npm install mddir -g 2、在项目文件夹中打开cmd 输入mddir 直接生成项目结构文档 3、找到名字：directoryList.md的文件就是目录工程文件树

.md文件看不到目录

04-01

### 如何在 `.md` 文件中显示目录为了使 `.md` 文件中的目录可见，可以采用自动或手动的方式生成并嵌入目录。以下是具体实现方式： #### 自动生成目录可以通过工具自动生成目录，并将其嵌入到 `.md` 文件中。 1. **使用 `i5ting_toc` 工具** 安装该工具后，可以在命令行中执行以下操作： ```bash npm install -g i5ting_toc ``` 接着通过如下命令为指定的 `.md` 文件生成目录： ```bash i5ting_toc -f 你的文件名.md ``` 此外，还可以直接预览 `.md` 文件的效果[^2]。 2. **使用 `mddir` 工具** 如果需要生成整个项目的目录结构而非单个文件内的目录，则可考虑使用 `mddir` 工具： ```bash npm install mddir -g cd 到目标路径 mddir ``` 自动生成名为 `directoryList.md` 的文件，其中包含了完整的项目目录树结构。 #### 手动编写目录如果不想依赖外部工具，也可以手动创建目录部分。例如： ```markdown ### 目录 1. [前言](#前言) 2. [语法详解](#语法详解) - [2.1 目录的自动生成](#目录的自动生成) - [2.2 手动书写目录](#手动书写目录) 3. [使用场景及实例](#使用场景及实例) 4. [小结](#小结) 5. [其他文章](#其他文章) ``` 上述代码片段定义了一个简单的链接列表作为文档内部导航条目，点击这些超链即可跳转至相应章节位置[^1]。对于更复杂的 Markdown 文档来说，建议优先尝试自动化解决方案以减少维护成本；而对于小型静态页面则可能更适合采取手工调整模式来满足个性化需求。 ```python # 示例 Python 脚本用于演示如何读取 .md 文件内容并插入 TOC (Table Of Contents) def insert_toc(file_path, toc_content): with open(file_path, 'r+', encoding='utf8') as f: content = f.read() new_content = "# Table of Contents\n" + toc_content + "\n\n" + content f.seek(0) f.write(new_content) if __name__ == "__main__": file_name = "example.md" table_of_contents = """ 1. [Introduction](#introduction) 2. [Details](#details) """ insert_toc(file_name, table_of_contents) ``` 此脚本展示了怎样向现有的 Markdown 文件头部追加一个预先准备好的目录字符串。