https://github.com/zhenghaoyang24/filetree
Generate a file tree from local files and export the file structure.根据本地文件夹生成文件树，导出文件结构。
https://github.com/zhenghaoyang24/filetree
filetree folder-structure
Last synced: about 1 month ago
JSON representation
Generate a file tree from local files and export the file structure.根据本地文件夹生成文件树，导出文件结构。
- Host: GitHub
- URL: https://github.com/zhenghaoyang24/filetree
- Owner: zhenghaoyang24
- License: mit
- Created: 2024-12-29T14:02:17.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-09T05:46:02.000Z (4 months ago)
- Last Synced: 2025-02-08T05:29:39.039Z (3 months ago)
- Topics: filetree, folder-structure
- Language: Vue
- Homepage: https://files-tree.netlify.app/
- Size: 7.85 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FileTree
[English](https://github.com/zhenghaoyang24/filetree/blob/master/README_EN.md)
## 项目简介
FileTree 是一个基于 `Vue3` 的工具，你可以选择一个本地文件夹，并根据其结构生成清晰的文件树。
生成的文件树可以直观地展示复杂的文件夹结构与文件基本信息，并支持导出为适用于 `Markdown` 增强的格式，方便在 `Markdown` 文件中使用。
## 功能特性
- **文件夹选择**：你可以选择本地文件夹，系统会自动解析其结构。
- **文件树生成**：根据文件夹结构生成清晰的文件树，支持展开/折叠操作。
- **导出功能**：将文件树导出为 `Markdown` 兼容的格式，方便在支持 `Markdown` 增强的编辑器中使用，例如博客主题 [theme-plume](https://theme-plume.vuejs.press/)。
- **直观展示**：通过树形结构直观展示复杂的文件夹层次关系与文件基本信息。
## 示例
### 文件树示例
### 导出的 Markdown 格式
```markdown
- example
- App.vue
- index.ts
- folder-02
- JavaScript.js
- folder-01
- text.txt
```
## 安装与运行
1. **克隆项目**：
```bash
git clone [email protected]:zhenghaoyang24/filetree.git
cd filetree
```
2. **安装依赖**：
```bash
npm install
```
3. **运行项目**：
```bash
npm run dev
```
4. **构建项目**：
```bash
npm run build
```
## 贡献指南
欢迎提交 Issue 和 Pull Request 来改进项目。
## 许可证
本项目采用 **MIT** 许可证。详情请参阅 [LICENSE](https://github.com/zhenghaoyang24/filetree/blob/master/LICENSE) 文件。
---
感谢使用 FileTree！希望它能帮助你更高效地管理和展示复杂的文件夹结构。