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

最新推荐文章于 2024-04-17 17:56:37 发布
最新推荐文章于 2024-04-17 17:56:37 发布
阅读量1.9k 收藏 2
点赞数
文章标签： macos 前端 vscode treeview
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43568833/article/details/122680356
版权

需求：当编写项目文档时，需要在 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
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
tree 命令
weixin_30917213的博客
07-13 634
LMXMN117:Mac Driver will.wei$ tree -N >/tmp/savs.txt (1)tree -a 显示所有文件和目录 (2)tree -d 显示目录名称而非内容 (3)tree -f 在每个文件或目录之前，显示完整的相对路径名称 ...
GitHub - 自动构建 GitHub 项目的 README.md 目录
ChenBin113
11-12 543
本文适合支持 Markdown 语法的文本的自动化目录构建。 结果 目录自动生成，可自动化更新。 # 目录 <!-- MarkdownTOC levels="1,2" autolink="true" --> - [LeetCode 题解](#leetcode-%E9%A2%98%E8%A7%A3) - [链表](#%E9%93%BE%E8%A1%A8) - [栈-队列](...
通过node遍历某个目录从而生成md文件展示层级目录结构
最新发布
liulang68的博客
04-17 461
【代码】通过node遍历某个目录从而生成md文件展示层级目录结构。
.md文件自动生成项目目录结构，预览.md文件
qq_37141525的博客
08-26 8426
自动生成项目目录结构 1）安装mddir (-g是全局安装，可以选择不全局安装，这里因为以后都要使用所以选择的全局安装） npm install mddir -g 2）cd 到你想生成目录的工程结构，直接运行mddir mddir 会有一个叫directoryList.md的文件，目录结构就在里面 我项目生成的目录结构长成这样： 记得要在目录结构的前后方都写上```，不然...
如何在README.md中使用及生成项目目录结构
时光清浅处，一步一安然
07-05 5233
首先进入需要生成目录结构的文件夹，在路径处输入并回车。 输入命令并回车。就会在当前目录下生成一个名为的文件。 在文档中找到这个文件并打开。 将需要的部分复制到README.md文档中，并加上``````。 3. 同上第四步，复制到所需位置即可。...
md文件生成项目目录树
liuqiao0327的专栏
07-05 4294
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 5886
博文参考原文链接地址：https://www.jianshu.com/p/4198c8a2ea8b 进入需要生成目录结构的文件夹，将路径替换为"cmd"并回车 输入命令： tree /f > list.txt 在当前文件夹下找到名为 list.txt 的文件 打开文件即可预览文件目录结构 将目录层级复制到README.md文件中【开头加上```和.】 README.md 文件效果预览 ...
ReadMe-Generator:我使用简单的NodeJS应用程序来构建readme.md文件
04-05
5. **项目结构**：理解一个Node.js应用的典型项目结构，包括`package.json`文件的配置，源代码目录的组织，以及测试文件的编写。 6. **版本控制**：项目可能使用Git进行版本控制，理解Git的基本操作，如`git init`...
README.md-Generator
03-27
3. **文件生成**：将处理后的Markdown文本写入到名为"README.md"的文件中，通常位于项目的根目录下。 4. **命令行工具**：如果项目提供命令行接口，用户可以通过特定命令快速生成README文件。 5. **配置文件**：可能...
readme-generator：用于轻松创建和格式化项目README.md文件的生成器
02-20
**readme-generator** 是一个基于 **JavaScript** 的实用工具，旨在简化项目中 **README.md** 文件的创建和格式化过程。在开源世界中，**README.md** 文件是项目的重要组成部分，它提供了项目的简介、安装指南、使用...
Professional-README.md-Generator
03-28
【Professional-README.md-Generator】是一款专为开发者设计的工具，用于快速生成专业且具有高质量的README.md文件。在开源项目或个人项目中，README文件是项目的第一印象，它提供了项目的基本信息、安装指南、使用...
mddir生成结构目录.bat
04-24
项目使用markdown来编辑项目信息介绍，该脚本使用开源工具 mddir 生成项目文件目录结构图，使用该脚本需要安装node
python 目录结构
11-22
多种方式的python 目录结构的使用，解决做不到 模块的问题
从Readmemd文件创建美观简单的HTML页面
08-11
记住，根据实际的`fiddly-master`目录结构和内容，可能需要调整文件路径和引入方式。 总结起来，将Readme.md转换为HTML页面涉及以下步骤： 1. 安装并使用Markdown解析库（如`marked`）。 2. 读取Readme.md文件内容...
mddir自动生成文件目录结构工具
donghua201的博客
09-25 473
mddir是一个基于项目目录结构动态生成目录机构md文件的工具，它可以帮助梳理项目的基本结构。使用mddir可以将目录结构输出为 Markdown 格式，方便在文档中展示文件和文件夹的组织结构。通过使用 mddir，可以快速生成包含文件和文件夹的目录结构，以及为其添加标题、缩进和链接等样式。
README.md自动生成目录（treer用法）
weixin_42662753的博客
02-14 1592
README.md自动生成目录（treer用法）
readme生成md目录文件
重剑无锋博客
09-15 216
代码结构readme生成
linux源码目录结构详解
zhoujia666的专栏
04-14 654
/bin 这是存放ls, mv, rm,mkdir, rmdir, gzip, tar, telnet及ftp等等常用执行程序的地方，有时候这个目录的内容与/usr/bin是一样的。 /boot 没错，这里就是放置你 Linux 核心与开机相关档案的地方，这个目录底下的vmlinuz-xxx 就是Linux 的 Kernel 。而如果你的开机管理程序选择grub的话，那么这个目录内还有/bo
【readme】生成常见的树型目录结构md文本
weixin_44002043的博客
05-30 372
【代码】【readme】生成常见的树型目录结构md文本。
c++ 项目目录结构
05-24
C++ 项目的目录结构没有固定的标准，但是一般会按照以下方式组织： ``` project/ ├── bin/ # 存放可执行文件 ├── build/ # 存放编译生成的中间文件 ├── include/ # 存放头文件 ├── lib/ # 存放静态库和动态库 ├── src/ # 存放源代码 ├── test/ # 存放测试代码 ├── doc/ # 存放文档 ├── LICENSE # 版权信息 └── README.md # 项目说明 ``` 其中，`src` 目录中包含所有的源代码文件，`include` 目录中包含所有的头文件，`bin` 目录中存放可执行文件，`lib` 目录中存放静态库和动态库。`test` 目录中包含所有的测试代码，`doc` 目录中存放项目文档，`LICENSE` 文件用于存放版权信息，`README.md` 文件用于存放项目说明。 此外，还可以根据需要添加其他的目录，例如存放配置文件或资源文件的目录。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值