【开源自荐】高效生成文件夹目录注释树,让技术文档编写变得轻松愉快! 🎉

项目介绍

项目名称:Annotree :evergreen_tree:
项目简介:高效生成文件夹目录注释树,让技术文档编写变得轻松愉快!:tada:

GitHub 地址:GitHub - itchaox/annotree: Generate folder directory annotation tree | 生成文件夹目录注释树

这是我的首个正式开源项目,如果它对你有帮助,:pray:t2: 请给我一个 Star :star: 并分享给你的朋友们,这对我意义重大,谢谢 :sparkling_heart:
你的反馈和支持 :100:,是我不断改进和积极更新软件的最大动力~

官方文档:https://www.annotree.com
系统支持:Mac、Windows、Linux
软件下载方式:官方文档 → 软件下载页面

功能预览图

5f8907d0f69773808dbab959135afbc5.gif

功能特性

  1. :sparkles: 实时预览:修改配置后,实时预览文件夹目录树的效果。
  2. :pen: 便捷注释:通过简单切换输入框来编写注释,显著提升使用效率。
  3. :no_entry_sign: 文件和文件夹忽略:轻松忽略不需要的文件和文件夹,确保目录树只展示你关心的内容。
  4. :open_file_folder: 自动打开导出文件:导出文件后自动打开,节省时间,让工作流程更加流畅。
  5. (更多功能介绍,请参考官方文档或B站搜索 Annotree 的视频介绍)

如果你需要生成文件夹目录注释树,推荐试试 Annotree :evergreen_tree:,确实是比较好用的。

现在项目正在积极更新中,如果你有任何建议和反馈,都可以在 GitHub Issue 中进行反馈,也可以通过官方文档的反馈渠道添加 Annotree 的微信群进行更高效的沟通~

2 个赞

看了一下体积……………………

不愧是electron,代码没几行。安装包100多m

顺便说一下,安装包这么大,一方面是electron的问题,一方面是你的依赖的问题,electron会把 dependencies下面的依赖打包进安装包,但你这个项目你把大部分依赖都写在dependencies下面了,导致巨大。

我看了一下你这个项目,你其实只需要把@electron-toolkit这一个依赖放到dependencies下面,其他的依赖放到devDependencies下面,安装包应该可以减少1/4

现在包体积确实大,这是我第一次使用 electron 开发桌面端应用,后续我会去研究如何让包体积尽可能减少。

个人建议可以考虑搞个没有GUI的命令行版本,或许体积能小不少。

功能上,希望能有灵活的排序方式,不光是按字母顺序。
突然看到文件夹不是在最上面,一下好不适应。 :grinning:

非常感谢指导,我去尝试一下

感谢反馈,但是命令行版本应该不会出的。只是现在功能稳定后,以后可能出 web 版本

你好,你期望是如何排序

了解了,就是文件夹优先排序哈,我去调整下

不知是不是我电脑问题,但至少 Directory Lister 在我电脑显示是没有问题的。
强迫症犯了。 :face_with_peeking_eye:

感谢反馈,这个是已知问题,因为中文和英文的字符长度不一致导致的,我后续会修复~

太棒了,老哥! 刚刚按照你这个方式,应用体积从 416 M 直接降低了 261 M,太有用了,感谢感谢! 再请教下还有什么其他能降低应用体积包的方法吗,我也自己再去查查

还不发个新版本庆祝一下。 :face_with_peeking_eye:

我整理一下,就发个新版本,最近还新增了好几个功能。老哥你在我那个微信群没有~