一个用于生成带注释目录树的工具，极大地方便技术文档的编写

中文 | English

项目介绍

本项目基于 folder-explorer 并进行了进一步开发。感谢 FairyEver 的创意与贡献！

这是我的第一个正式开源项目。如果它对您有帮助，请 Star ⭐️ 并与您的朋友分享。这对我意义重大，谢谢 💗！

官方文档：https://annotree.com

如需下载最新版本，请访问 Github Release

预览 🎉

项目结构 📇

反馈渠道

该项目目前处于 MVP（最小可行产品）阶段。如果您有任何意见或建议，请随时通过以下方式与我联系：

• 提交 GitHub Issue

为何进一步开发

1. folder-explorer 的某些功能对我来说是冗余的，且不符合我的使用习惯。
2. 在 folder-explorer 中，每次都需要导出才能查看配置效果，我觉得这很不方便。我希望能够实时预览。
3. 在 folder-explorer 中编辑笔记时，每次都需要右键点击打开编辑笔记菜单，我个人觉得这不太方便。

功能特性

1. ✨ 实时预览：无需导出文本，即可实时查看带注释的文件树效果，使文档编写更加直观高效。
2. 🖊 便捷的注释：通过切换输入框轻松编写注释，避免了繁琐的右键菜单操作，提高了效率。
3. 🚫 文件和文件夹忽略：支持忽略特定的文件夹和文件类型，确保仅显示所需的文件结构，保持文件树简洁。
4. 📂 自动打开导出文件：导出后自动打开文件，无需手动查找文件，节省时间并使工作流程更加顺畅。

功能介绍

• 点击扫描按钮后，打开文件选择器，选择要扫描的文件夹，然后开始扫描。

全局配置

• 自动打开文件：导出后自动打开文件。
• 忽略文件夹：忽略无需扫描的文件夹，以避免性能损耗甚至程序无响应，例如 node_modules 文件夹，该文件夹会被程序自动忽略。
• 忽略以“.”开头的文件夹：这些文件夹在 MacOS 和 Linux 上默认是隐藏的。
• 仅扫描文件夹：忽略所有文件，仅扫描文件夹。
• 忽略以“.”开头的文件：这些文件在 MacOS 和 Linux 上默认是隐藏的。
• 忽略文件类型：您可以选择忽略不必要的文件类型，以提高扫描效率。
• 扫描深度：设置扫描目录的深度，0 表示所有深度，每增加 1 表示扫描深度 +1。
• 默认名称：导出文本的默认名称配置。

预览区域配置

• 注释格式化：填充注释的格式
• 桥接字符最小数量：最长路径上显示的桥接字符数量
• 桥接填充字符：输入一个单字节填充字符，例如：*、#、$、-、@、_ 等。
• 始终显示桥接：配置是否显示没有注释的桥接。
• 导出：设置相关配置，写入注释，并导出注释文件树结构。

💗 赞助

• 如果 Annotree 对您有帮助，欢迎支持我们！☕️
• 您的每一份支持都将激励我持续改进 Annotree，为您提供更好的 Annotree。非常感谢！🙏🏻
• 如果您暂时无法支持我们，给一个 Star ⭐ 也是对我莫大的支持！

赞助 🎉

Star History Chart ⭐️

致谢

1. 感谢 electron-vite 提供 electron 框架，这极大地提高了我的开发效率。
2. 感谢 md 为我提供了 README.md 文档的创意。

谁在使用它

如果你使用 Annotree 工具生成了带注释的项目文件树结构，并希望在此 README 中展示你的项目，请在 Discussions #2 留言。

• Annotree