Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

我基于该软件二次开发出了 Annotree:一款生成带注释的目录树工具 ✨✨✨ | 帮助你高效地编写技术文档,大家有目录树需求的,欢迎来看看! #79

Open
itchaox opened this issue Jul 18, 2024 · 0 comments

Comments

@itchaox
Copy link

itchaox commented Jul 18, 2024

Annotree 是基于 folder-explorer 进行二次开发,🙏🏻非常感谢 FairyEver 的创意和贡献!

项目介绍 🥳

项目名称:Annotree
项目简介:一款生成带注释的目录树工具
GitHub 地址:https://github.com/itchaox/annotree
官方文档:https://www.annotree.com
使用场景:编写技术文档的目录注释树,帮助你高效地编写技术文档。

这是我的第一个正式开源项目,如果对你有帮助,感谢 Star ⭐️ 和分享给你的朋友们,这对我很重要,谢谢 💖

效果演示:

20240716092318_rec_

官方文档首页:

image

功能展示 🤩

扫描

点击扫描按钮后打开文件选择器,选择需要扫描的文件夹,即可开始扫描。

20240713233436_rec_.gif

自动打开文件

导出文件后自动打开。

20240713233511_rec_.gif

忽略文件夹

忽略不需要扫描的文件夹,避免性能损失甚至程序失去响应,比如:node_modules 文件夹,程序内部已自动忽略 node_modules 文件夹。

20240713233557_rec_.gif

忽略以 "." 开头的文件夹

这类文件夹在 MacOS 和 Linux 上是默认隐藏的文件夹。

20240713235057_rec_.gif

只扫描文件夹

忽略所有文件,只扫描文件夹。

20240713233700_rec_.gif

忽略以 "." 开头的文件

这类文件在 MacOS 和 Linux 上是默认隐藏的文件。

20240713234828_rec_.gif

忽略文件类型

在扫描一次后,会生成此次扫描后的所有文件类型,可以选择忽略不需要的文件类型,以提高扫描效率。

20240713233809_rec_.gif

扫描深度

设置扫描目录的深度,0 为所有深度,每递增一个数字则代表扫描深度 +1。

20240713233922_rec_.gif

默认名称

导出文本的默认名称配置。

20240713234030_rec_.gif

预览区配置

注释格式化

填充注释的格式

20240713234450_rec_.gif

桥梁最短字符数

路径最长的地方,显示的桥梁字符数

20240713234351_rec_.gif

桥梁填充字符

输入一个单字节填充字符,比如:*,#,$,-,@,_ 等。

20240713234259_rec_.gif

始终显示桥梁

配置没有注释的地方是否显示桥梁。

20240713234200_rec_.gif

导出

设置好相关配置,编写好注释后,导出注释目录树。

20240713234122_rec_.gif

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant