hi，大家好，我是愛聽書的程式設計師阿超
非常開心能在這裡介紹我的第一個正式開源專案 Annotree，專案具體情況如下，請繼續閱讀📖~
Annotree 註釋樹
一款生成帶註釋的目錄樹工具，大大方便技術文件的編寫
專案介紹 🎉
本專案基於 folder-explorer 進行二次開發，感謝 FairyEver 的創意和貢獻！
- GitHub 地址：https://github.com/itchaox/annotree
- 官方文件：https://www.annotree.com
- 影片講解：https://www.bilibili.com/video/BV1fS421R7UM
這是我在 B 站釋出的第 2 個技術影片，如果對你有幫助的話，感謝一鍵三連，加關注~ 💗
- 使用場景：編寫技術文件的目錄註釋樹，幫助你高效地編寫技術文件。
這是我的第一個正式開源專案，如果對你有幫助，感謝 Star ⭐️ 和分享給你的朋友們，這對我很重要，謝謝 💖！
效果演示 📺︎
官方文件首頁 📖
- 官方文件：https://www.annotree.com
功能展示 🛠
掃描
點選掃描按鈕後開啟檔案選擇器，選擇需要掃描的資料夾，即可開始掃描。
自動開啟檔案
匯出檔案後自動開啟。
忽略資料夾
忽略不需要掃描的資料夾，避免效能損失甚至程式失去響應，比如：node_modules 資料夾，程式內部已自動忽略 node_modules 資料夾。
忽略以 "." 開頭的資料夾
這類資料夾在 MacOS 和 Linux 上是預設隱藏的資料夾。
只掃描資料夾
忽略所有檔案，只掃描資料夾。
忽略以 "." 開頭的檔案
這類檔案在 MacOS 和 Linux 上是預設隱藏的檔案。
忽略檔案型別
在掃描一次後，會生成此次掃描後的所有檔案型別，可以選擇忽略不需要的檔案型別，以提高掃描效率。
掃描深度
設定掃描目錄的深度，0 為所有深度，每遞增一個數字則代表掃描深度 +1。
預設名稱
匯出文字的預設名稱配置。
註釋格式化
填充註釋的格式
橋樑最短字元數
路徑最長的地方，顯示的橋樑字元數
橋樑填充字元
輸入一個單位元組填充字元，比如：*，#，$，-，@，_ 等。
始終顯示橋樑
配置沒有註釋的地方是否顯示橋樑。
匯出
設定好相關配置，編寫好註釋後，匯出註釋目錄樹。
下載地址 ⬇️
- 下載地址：https://www.annotree.com/download.html
反饋渠道 💬
如果你有任何意見或建議，歡迎透過以下方式與我聯絡：
- 提交 GitHub Issue
- 飛書群 點選入群
我為何選擇飛書群作為社群溝通渠道：
- 我平時飛書用的較多，溝通方便。
- 飛書話題群溝通問題，效率更高。
開發 Annotree 的故事 📚️
本專案基於 folder-explorer 進行二次開發，感謝 FairyEver 的創意和貢獻！
起源
- 2023 年 6 月，我負責搭建公司內部前端基礎框架。框架搭建完成後，我希望透過註釋來幫助團隊成員快速理解目錄結構。
- 我發現 tree 命令可以掃描專案目錄結構，但註釋需要手動新增，不夠便捷。
- 之後發現了 folder-explorer，這個工具提供了目錄註釋和對齊功能，但仍不完全符合我的需求。
- 為了解決上述問題，我基於 folder-explorer 進行了二次開發，建立了 Annotree。
- 由於其他工作和對 Electron 不熟悉，直到 2024 年 7 月我才開始開發 Annotree。
為何二次開發
- folder-explorer 的部分功能對我而言冗餘，不符合我的使用習慣。
- folder-explorer 匯出文字後才看到效果，我希望有實時預覽功能。
- folder-explorer 編輯備註需要右鍵開啟選單，操作不便。
期望 🥳
- 這是我做的第一個正式開源專案，大家的反饋和支援，對我很重要 💗，謝謝 🙏🏻
- 現在專案還處於快速迭代中，期待大家的反饋與 pr，期待與大家一起共建更好的 Annotree 🤝🏻
致謝 🙏🏻
- 感謝 electron-vite 提供的 electron 框架，大大提升我的開發效率。
- 感謝 md 提供給我的 README.md 文件思路。
誰在使用 👤
如果你使用了本 Annotree 工具生成帶註釋的專案檔案樹形結構，並且希望在本專案 README 中展示你的專案，請到 Discussions #2 留言。
- Annotree