Hi, everyone, I'm a programmer who loves to listen to booksChao
I'm very happy to introduce my first official open source project Annotree, the project details are as follows, please read on 📖~!
Annotree
A tool to generate annotated directory trees, greatly facilitating the preparation of technical documentation
Project 🎉
The project is based onfolder-explorer Secondary development is carried out thanks to theFairyEver creativity and contribution!
- GitHub address:/itchaox/annotree
- Official Documentation:
- Video Explanation:/video/BV1fS421R7UM
This is the 2nd tech video I've posted on B. Thanks for the one-click trifecta and adding a follow if it's helpful to you~ 💗
- Usage Scenario: Write a catalog annotation tree for technical documentation to help you write technical documentation efficiently.
This is my first official open source project, and if it's of any help to you.Thanks to Star ⭐️ and share it with your friends, which is important to me.Thank you 💖！
Demo 📺︎
Official Documentation Home Page 📖
- Official Documentation:
Function Showcase 🛠
scanning
Click on the Scan button to open the file selector and select the folder that needs to be scanned to start scanning.
Automatically open files
Automatically open the file after exporting it.
Ignore Folders
Ignore folders that don't need to be scanned to avoid performance loss or even program unresponsiveness, e.g., the node_modules folder, which is automatically ignored internally by the program.
Ignore folders beginning with "." Folders beginning with ".
These are hidden folders by default on MacOS and Linux.
Scanning folders only
Ignore all files and scan only folders.
Ignore files that start with "." Files that begin with
Such files are hidden by default on MacOS and Linux.
Ignore file types
After scanning once, all file types from this scan will be generated, and you can choose to ignore unwanted file types to improve scanning efficiency.
Scanning depth
Sets the depth of the scanned directory, with 0 being the full depth and each incremental digit representing a +1 scanning depth.
Default name
Default name configuration for exported text.
Note Formatting
Formatting of filler comments
Minimum number of bridge characters
Number of bridge characters displayed where the path is longest
Bridge filler characters
Enter a single-byte padded character, e.g., *, #, $, -, @, _, etc.
Always show bridges
Configure whether to show bridges where there are no annotations.
derive
After setting up the relevant configuration and writing annotations, export the annotation catalog tree.
Download ⬇️
- Download Address:/
Feedback channels 💬
If you have any comments or suggestions, please feel free to contact me through the following ways:
- submit (a report etc)GitHub Issue
- Flying Book GroupClick to join the group
Why I chose the Flybook group as a community communication channel:
- I usually use the fly book more for easy communication.
- Flybook topic groups communicate issues more efficiently.
The story of developing Annotree 📚️
The project is based onfolder-explorer Secondary development is carried out thanks to theFairyEver creativity and contribution!
genesis
- In June 2023, I was responsible for building the basic framework for the company's internal front-end. Once the framework was built, I wanted to help team members quickly understand the catalog structure through annotations.
- I found that the tree command can scan the project directory structure, but the comments need to be added manually, which is not convenient enough.
- Then I found folder-explorer, a tool that provides directory annotation and alignment, but still doesn't exactly fit my needs.
- To solve the above problem, I have created Annotree based on folder-explorer.
- I didn't start developing Annotree until July 2024 due to other work and unfamiliarity with Electron.
Why secondary development
- Some of the features of folder-explorer are redundant for me and do not fit my usage habits.
- folder-explorer exports the text before seeing the effect, I would like to have a real-time preview function.
- folder-explorer Editing notes requires right-clicking to open the menu, which is inconvenient.
Expectations 🥳
- This is the first official open source project I've done, and everyone's feedback and support means a lot to me 💗 Thanks 🙏🏻
- Now the project is still in rapid iteration, look forward to your feedback and pr, look forward to working with you to build a better Annotree 🤝🏻
Acknowledgements 🙏🏻
- (express) thankselectron-vite The electron framework provided has greatly improved my development efficiency.
- (express) thanksmd Provide me with documentation ideas.
Who's using it 👤
If you have used this Annotree tool to generate an annotated tree structure of your project files and would like to present your project in this project README, go to theDiscussions #2 Leave a message.
- Annotree