itchaox/annotree

Generate folder directory annotation tree | 生成文件夹目录注释树

Annotree

A tool for generating annotated directory trees, greatly facilitating the writing of technical documentation

中文 | English

Project Introduction

This project is based on folder-explorer and has been further developed. Thanks to FairyEver for the creativity and contribution!

This is my first official open-source project. If it helps you, please Star ⭐️ and share it with your friends. It means a lot to me, thank you 💗!

Official documentation: https://annotree.com

For the latest version download, please visit Github Release

Preview 🎉

Feedback Channels

The project is currently in the MVP (Minimum Viable Product) stage. If you have any opinions or suggestions, please feel free to contact me through the following ways:

• Submit a GitHub Issue

Why Further Development

1. Some features of folder-explorer were redundant for me and didn't fit my usage habits.
2. In folder-explorer, you need to export to see the configuration effect each time, which I found inconvenient. I wanted real-time preview.
3. When editing notes in folder-explorer, you need to right-click to open the edit note menu each time, which I personally found not very convenient.

Features

1. ✨ Real-time preview: View the annotated file tree effect in real-time without exporting text, making document writing more intuitive and efficient.
2. 🖊 Convenient annotation: Easily write annotations by switching input boxes, avoiding cumbersome right-click menu operations and improving efficiency.
3. 🚫 File and folder ignoring: Support ignoring specific folders and file types, ensuring only the file structure you need is displayed, keeping the file tree concise.
4. 📂 Automatic opening of exported files: Automatically open files after exporting, no need to manually search for files, saving time and making the workflow smoother.

Feature Introduction

• After clicking the scan button, open the file selector, choose the folder you want to scan, and start scanning.

Global Configuration

• Automatically open files: automatically open files after exporting.
• Ignore folders: ignore folders that do not need to be scanned to avoid performance loss or even program unresponsiveness, such as the node_modules folder, which is automatically ignored by the program.
• Ignore folders starting with ".": These folders are hidden by default on MacOS and Linux.
• Scan only folders: ignore all files and only scan folders.
• Ignore files starting with ".": These files are hidden by default on MacOS and Linux.
• Ignore file types: you can choose to ignore unnecessary file types to improve scanning efficiency.
• Scan depth: set the depth of the scan directory, 0 means all depths, and each increment represents a scan depth +1.
• Default name: the default name configuration for exported text.

Preview area configuration

• Annotation formatting: the format of the fill annotation
• Minimum number of bridge characters: the number of bridge characters displayed at the longest path
• Bridge fill character: enter a single-byte fill character, such as: *, #, $, -, @, _, etc.
• Always show bridges: configure whether to show bridges where there are no comments.
• Export: set the relevant configuration, write the comments, and export the annotation file tree structure.

Star History Chart ⭐️

Acknowledgements

1. Thanks to electron-vite for providing the electron framework, which greatly improved my development efficiency.
2. Thanks to md for providing me with README.md document ideas.

Who's Using It

If you've used the Annotree tool to generate an annotated project file tree structure and would like to showcase your project in this README, please leave a message at Discussions #2.

• Annotree

annotree's Issues

Export image as PDF or SVG ?

Annotree result can now export to txt or raster image, will it be able to export some vector graphics types, like PDF or SVG ? It would be better if we could use these vector graphics in other programs.

Issue Submission Rules 📜

💯 To help more users discover and resolve issues, please use English when submitting and responding to issues.

1. Describe the Issue

Please provide as much detail as possible, including:

• Issue Overview: A brief description of the issue encountered.
• Reproduction Steps: Clearly list the steps to reproduce the issue.
• Expected Behavior: Describe the expected behavior or outcome.
• Actual Behavior: Describe the actual behavior or outcome.

2. Additional Information

To help us locate and resolve the issue more quickly, please provide the following information if possible:

• Screenshots: Attach relevant screenshots, etc.
• Environment Information: Include details such as operating system, software version, etc.

3. Labels

We use the following labels to categorize and prioritize issues:

• Category: Such as “bug”, “feature request”, “documentation”, etc.
• Priority: Such as “high priority”, “medium priority”, “low priority”, etc.

4. Code of Conduct

• Respect: Please be friendly and respectful when submitting issues and communicating with us.
• Thanks: We appreciate your feedback and contributions!

Thank you for your understanding and cooperation! If you have any questions, please feel free to contact us.

The installation package is too large, I hope it can be made smaller 📦️

字符串显示emsp的问题

          > ![Snipaste_2024-07-26_17-23-46](https://private-user-images.githubusercontent.com/52968452/352478968-d26ba3c7-ac94-4208-9b8a-9e3cd9f79dbf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE5ODc0MjEsIm5iZiI6MTcyMTk4NzEyMSwicGF0aCI6Ii81Mjk2ODQ1Mi8zNTI0Nzg5NjgtZDI2YmEzYzctYWM5NC00MjA4LTliOGEtOWUzY2Q5Zjc5ZGJmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzI2VDA5NDUyMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWFhZjAyMTNlOGM2NGM5ZjMwZDE3ZGMwYjYzOTE3OWViMzFmMmUzYTBhYTQ1YWY0NzU0MWQyYzRmZmY3ZDM3OGImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.LscPTXcqzcWYXWqfKtPb1sujxfa9KSits6NPp9W13zY)

现在 v0.1.8新版本支持直接复制预览区的数据了，可以再试试是否还有这个情况，然后麻烦给我说下后续，我空了去复显排查一下~

Originally posted by @itchaox in #6 (comment)

One-click folding and unfolding of all nodes in the editing area

Provide a help button to display relevant shortcut keys, etc.

For example: provide a ? button, hover to display shortcut keys, such as tab to focus on the next input box, shift + tab to focus on the previous input box, etc.

Folder and file regular ignore mode

Expected: Regular ignore mode for folders and files, which can be more flexible

是否可以直接发布为一个独立的静态网页工具？

发布为一个免安装、随处可部署（例如GitHub Page）、直接使用（只要有网就能打开使用）的静态网页工具或许更适合这一类工具的定位？

Mac Intel series fails to open after installing Annotree

忽略文件

建议可以根据用户目录下的.gitignore自动对所包含的文件进行忽略，也可自定义忽略文件以及对文件树结构的深度进行配置

Temporary Hold on PR Submissions ⛔️

Hello, I’m Wang Chao, the author of Annotree. 🥳

Thank you so much for your willingness to contribute PRs and help build a better Annotree. Currently, Annotree is still in the MVP stage, and the code structure is somewhat messy. This could affect future maintenance and PR submissions. 🛠️

Therefore, I plan to take some time to reorganize the code, including extracting components and methods. To avoid wasting your valuable time, please refrain from submitting PRs for now. ⏳

If you’d like to contribute PRs in the future, please leave a comment below saying “I want to PR.” Once I’ve organized the code, I’ll notify everyone individually and look forward to your contributions. 🤝

Thank you for your understanding and support. I look forward to working together to make Annotree even better! 🚀

可以增加适配IDEA插件【中文标注：TreeInfotip】

TreeInfotip的配置文件 DirectoryV3.xml 导入读取即可
包体太大，希望中文注释排成一列，而不是固定的分割线

<?xml version="1.0" encoding="UTF-8"?>
<trees>
    <tree path="/lib/providers" title="状态管理"/>
    <tree path="/lib/db/preference" title="持久化存储"/>
    <tree path="/lib/db/database" title="数据库"/>
    <tree path="/lib/l18n" title="国际化"/>
    <tree path="/lib/pages" title="页面"/>
... ....
</trees>

Added the default display of / after the folder

Expected: Add the default display of / after the folder, so that folders and files can be distinguished more intuitively

Scroll bar style optimization: make it thinner

导出txt后Nopad++打开显示emsp字符影响观感

Optimize file display

Desired file display order:

1. Folders are listed before files.
2. Folders and files are sorted in alphabetical order.

UI beautification

Expectation: Beautify the current UI interface to make it more beautiful

Annotree WeChat Group 🎉

🥳 Hello everyone, I am Wang Chao, the author of Annotree.
I have set up an Annotree WeChat group for better communication, and everyone is welcome to join. 🎉

QR code:

The length of Chinese and English characters caused the bridge to not align

Expectation: Bridges can also be aligned when Chinese and English exist

Display only the edit area or preview area

Join Ai

添加Ai功能，使得目录注释一部分由Ai自动生成，可以在Ai生成的基础上再做调整和修改

I hope that the expansion and collapse of the preview area will not affect the final result

I think the folding of folders should be for easy viewing during editing and previewing. When it comes to copying, I think the entire contents of the folded folder should also be copied (this can be done in the global configuration, allowing users to choose)

The exported data supports the format of mind map

Expectation: The exported data supports the format of mind map, which makes it easier to view the directory structure similar to handouts

The editing area provides a tree node search

Expectation: The editing area provides a tree node search, which makes it easier to find specific data