Readme.md中生成项目目录结构

最新推荐文章于 2023-12-29 04:56:13 发布
最新推荐文章于 2023-12-29 04:56:13 发布
阅读量2.1k 收藏 2
点赞数
文章标签： macos 前端 vscode treeview
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43568833/article/details/122680356
版权
本文介绍了如何在README.md文件中生成项目的目录结构。首先，通过安装HomeBrew，然后使用HomeBrew安装tree命令，接着在控制台运行tree命令生成当前目录的树形结构，最后将生成的目录树文本复制到README.md中，以清晰地展示项目结构。
摘要由CSDN通过智能技术生成

需求：当编写项目文档时，需要在 README.md 中对项目整体的目录结构以及文件的功能进行说明。

1、安装HomeBrew

参考：Mac安装HomeBrew&HomeBrew安装yarn_梦魇米莉的博客-CSDN博客

2、使用HomeBrew安装tree

brew install tree

3、使用 tree 在控制台生产当前目录树

// 因为实例项目为 js 项目，所以忽略了 node_modules，可根据真实项目选择性忽略文件目录，防止文件树过长
tree -I node_modules > tree.text

4、复制目录树文本到 README.md 中

执行上一步会生成一个tree.text文件，打开复制其中的内容

 

最低0.47元/天 解锁文章
梦魇米莉
关注
经验分享：给项目创建和编写README.md文件的步骤
软贱开发攻城狮
07-30 3710
在项目开发过程中，不仅要注意代码的编写质量，也要为合作开发打好基础，尤其是合作开发的时候，同事直接的代码需要熟悉，这就需要在开发的时候进行注释操作，方便别人维护和熟悉代码。除了上述两个重要的点之外，还需要在项目工程里面单独做项目大概情况介绍以及注意事项的操作，这就涉及到README.md文件的使用。 拿到一个新的项目，想要了解这个项目，恐怕首先想到的就是通过项目里的Readme文件了解信息。若觉得Readme文件里面的内容都是随便写写的话，那就大错特错了，git 、github、oschina、gitca
GitHub - 自动构建 GitHub 项目的 README.md 目录
ChenBin113
11-12 578
本文适合支持 Markdown 语法的文本的自动化目录构建。 结果 目录自动生成，可自动化更新。 # 目录 <!-- MarkdownTOC levels="1,2" autolink="true" --> - [LeetCode 题解](#leetcode-%E9%A2%98%E8%A7%A3) - [链表](#%E9%93%BE%E8%A1%A8) - [栈-队列](...
如何在README.md中使用及生成项目目录结构
时光清浅处，一步一安然
07-05 6289
首先进入需要生成目录结构的文件夹，在路径处输入并回车。 输入命令并回车。就会在当前目录下生成一个名为的文件。 在文档中找到这个文件并打开。 将需要的部分复制到README.md文档中，并加上``````。 3. 同上第四步，复制到所需位置即可。...
.md文件自动生成项目目录结构，预览.md文件
qq_37141525的博客
08-26 8814
自动生成项目目录结构 1）安装mddir (-g是全局安装，可以选择不全局安装，这里因为以后都要使用所以选择的全局安装） npm install mddir -g 2）cd 到你想生成目录的工程结构，直接运行mddir mddir 会有一个叫directoryList.md的文件，目录结构就在里面 我项目生成的目录结构长成这样： 记得要在目录结构的前后方都写上```，不然...
md文件生成项目目录树
liuqiao0327的专栏
07-05 4476
md文件生成项目目录树 1.安装mddir $ npm install mddir -g //全局安装 这种工具就是要全局安装 2.使用mddir 在当前想要生成的目录结构,直接使用mddir命令 $ mddir 结果会生成一个文件directoryList.md在当前项目的目录,里面包含当前项目的目录结构 |-- react-webpack |-- .babelrc |-- package-lock.json |-- package.json |-- readme.
在 README.md 中生成项目目录结构
J_____Q的博客
02-13 6183
博文参考原文链接地址：https://www.jianshu.com/p/4198c8a2ea8b 进入需要生成目录结构的文件夹，将路径替换为"cmd"并回车 输入命令： tree /f > list.txt 在当前文件夹下找到名为 list.txt 的文件 打开文件即可预览文件目录结构 将目录层级复制到README.md文件中【开头加上```和.】 README.md 文件效果预览 ...
tree 命令
weixin_30917213的博客
07-13 698
LMXMN117:Mac Driver will.wei$ tree -N >/tmp/savs.txt (1)tree -a 显示所有文件和目录 (2)tree -d 显示目录名称而非内容 (3)tree -f 在每个文件或目录之前，显示完整的相对路径名称 ...
README.md文件生成目录结构里的树形内容分布结构
weixin_40893448的博客
03-28 1926
此外，生成该项目的目录结构会自动的保存到README.md文件中，只需复制粘贴即可。这时终端会出现如下的结构，这时已经生成该项目的目录结构。此时表明成功，可以进行后续目录结构的生成。路径切换：进入所要生成目录的文件夹终端。首先打开命令提示符窗口，输入以下代码。然后，输入tree进行测试。
springboot 建readme_经验分享：给项目创建和编写README.md文件的步骤
weixin_39630126的博客
12-19 1435
在项目开发过程中，不仅要注意代码的编写质量，也要为合作开发打好基础，尤其是合作开发的时候，同事直接的代码需要熟悉，这就需要在开发的时候进行注释操作，方便别人维护和熟悉代码。除了上述两个重要的点之外，还需要在项目工程里面单独做项目大概情况介绍以及注意事项的操作，这就涉及到README.md文件的使用。拿到一个新的项目，想要了解这个项目，恐怕首先想到的就是通过项目里的Readme文件了解信息。若觉得R...
readme-generator：用于轻松创建和格式化项目README.md文件的生成器
02-20
**readme-generator** 是一个基于 **JavaScript** 的实用工具，旨在简化项目中 **README.md** 文件的创建和格式化过程。在开源世界中，**README.md** 文件是项目的重要组成部分，它提供了项目的简介、安装指南、使用...
mddir生成结构目录.bat
04-24
项目使用markdown来编辑项目信息介绍，该脚本使用开源工具 mddir 生成项目文件目录结构图，使用该脚本需要安装node
python 目录结构
11-22
多种方式的python 目录结构的使用，解决做不到 模块的问题
mddir自动生成文件目录结构工具
donghua201的博客
09-25 614
mddir是一个基于项目目录结构动态生成目录机构md文件的工具，它可以帮助梳理项目的基本结构。使用mddir可以将目录结构输出为 Markdown 格式，方便在文档中展示文件和文件夹的组织结构。通过使用 mddir，可以快速生成包含文件和文件夹的目录结构，以及为其添加标题、缩进和链接等样式。
README.md自动生成目录（treer用法）
weixin_42662753的博客
02-14 1717
README.md自动生成目录（treer用法）
如何为开发项目编写规范的README文件（windows），此文详解
诗筱涵的博客
11-25 2007
摘自：https://www.cnblogs.com/wj-1314/p/8547763.html 如何为开发项目编写规范的README文件（windows），此文详解 为什么要写这篇博客？ 　　其实我是一个入坑已经半年的程序员，因为不是计算机专业，只能自己摸索，所以我深知博客的重要性。每次我的学习笔记啊，项目的，面试题啊，有的，只要有时间，我肯定上传上来，一方面自己可以随时随地的看，另一方面也可以方便大家。 　　了解一个项目，恐怕首先都是通过其Readme文件了解信息。如果你以为Readm.
Markdown/README如何写出“文件目录结构”？
最新发布
SoulmateY的博客
12-29 9044
一个清晰、有组织的README文件对于任何项目都是不可或缺的，它不仅提高了工作效率，还能加强团队间的沟通和项目的可持续性。本文将引导你如何精心打造文件目录结构，使其既直观又具有可读性，从而提升你的项目管理技能。
.md文件自动生成项目目录结构
阿牛哥的博客
08-21 1534
.md文件自动生成项目目录结构
readme生成md目录文件
重剑无锋博客
09-15 248
代码结构readme生成
linux源码目录结构详解
zhoujia666的专栏
04-14 685
/bin 这是存放ls, mv, rm,mkdir, rmdir, gzip, tar, telnet及ftp等等常用执行程序的地方，有时候这个目录的内容与/usr/bin是一样的。 /boot 没错，这里就是放置你 Linux 核心与开机相关档案的地方，这个目录底下的vmlinuz-xxx 就是Linux 的 Kernel 。而如果你的开机管理程序选择grub的话，那么这个目录内还有/bo
readmify：自动化将package.json转换为README.md工具
11. "在读取'package.json'文件时，readmify会解析其结构，并利用Markdown语法将关键信息组织成清晰的文档格式，从而生成"README.md"文件。" 总结，"readmify"通过自动化的方式，解决了开发者在项目文档维护上的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值