README.md自动生成目录(treer用法)

一、使用

1.安装treer依赖

npm install treer -g

2.基本用法
进入所要生成目录的文件夹终端,输入

treer -e README.md

生成的文件目录
在这里插入图片描述
3.此时会把所有的子目录都生成,如果去掉,可以利用正则表达式,如

 treer -e README.md -i  /.js/

二、treer用法介绍

1.指定目录

默认的目录为当前的路径,可以通过-d 传入指定的路径

treer -d <指定路径>

2.导出结果

可以将结果导到文件中

 treer -e <导出路径>

3.忽略文件

有时候我们需要忽略一些文件名,比如我们的node_modules文件夹

$ treer -i <"文件名,支持正则表达式/regex/哦">

//如:treer -e tree.txt -i "/node_modules|.git|.idea|.editorconfig|visitor|dist|readme.md|server/"

4.官方文档

$ treer --help

  Usage: treer [options]

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -d, --directory [dir]  Please specify a directory to generate structure tree
    -i, --ignore [ig]      You can ignore specific directory name
    -e, --export [epath]   export into file
`readme.md`文件是一个项目的自述文件,通常用于在GitHub等代码托管平台上向用户展示项目的相关信息。一个清晰、详细的`readme.md`可以帮助用户快速了解项目的用途、安装方法、使用方法、贡献指南、许可证信息等。一个典型的`readme.md`目录结构可能如下: ```markdown # 项目名称 简介:简短介绍项目的主要功能和用途。 ## 目录 - [配置选项](#配置选项) - [常见问题解答](#常见问题解答) - [贡献指南](#贡献指南) - [许可证](#许可证) ## 安装 提供项目的安装步骤,可能包括依赖安装、环境配置等。 ## 快速开始 描述如何快速运行一个示例或者演示项目的基本功能。 ## 功能特性 列出项目的主要功能或者特性,以及它们的简短描述。 ## 使用方法 详细介绍如何使用项目,可能包含命令行选项、API文档、图形界面操作等。 ## 配置选项 如果项目允许配置,这里应列出所有可用的配置选项和它们的作用。 ## 常见问题解答 解答用户可能遇到的常见问题。 ## 贡献指南 说明如何为项目做出贡献,包括代码提交、文档编写、社区参与等。 ## 许可证 声明项目所使用的开源许可证。 ## 联系方式 提供项目维护者的联系方式,如电子邮件、论坛等。 ## 致谢 感谢对项目有贡献的个人或团队。 ``` 以上是一个`readme.md`的目录结构示例。实际编写时,应该根据项目的实际情况进行相应的调整和补充。Markdown格式支持标题、列表、链接、图片等元素,可以增强文档的可读性和信息的组织性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

名字还没想好☜

祝福你

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值