# FileRemark

**Repository Path**: ciguoguo/file-remark

## Basic Information

- **Project Name**: FileRemark
- **Description**: 本项目旨在提供一个简单的文件和目录备注管理系统，用户可以为指定目录下的所有文件和文件夹添加备注。所有备注会及时保存到 JSON 文件中，方便用户管理和查阅。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-18
- **Last Updated**: 2026-02-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FileRemark——文件备注系统

## 用途

本项目旨在提供一个简单的文件和目录备注系统，用户可以为指定目录下的所有文件和文件夹添加备注。所有备注会及时保存到 JSON 文件中，方便用户管理和查阅。

## 特性/特点

- **树形展示**：以树形结构展示文件和目录，用户可以轻松浏览。
- **及时保存**：用户在备注栏中输入内容，光标脱离备注栏后，系统会自动保存备注。
- **动态展开/折叠**：用户可以点击文件夹名称来展开或折叠其子目录，方便管理。
- **高亮显示**：在鼠标悬停时，高亮显示整行，增强可读性。
- **文件/目录区分**：先展示文件夹，后展示文件。同时，在组内按照升序排列。

## 文件结构

    /theTestFolder
    │
    ├── index.php        (入口文件)
    ├── styles.css
    ├── scripts.js
    ├── save_note.php
    └── folder-icon.png  (文件夹图标)
    └── file-icon.png    (文件图标)
    └── notes.json       (存储备注的 JSON 文件)

#### 安装教程

1.  将项目复制到自己的服务器（PHP环境）；
2.  将index.php第3行中的$directory替换为你的目录；
3.  在浏览器地址中访问index.php。

#### 使用说明

1.  及时保存用到Ajax，需要在线服务器。
2.  有2个分支，一个用了Ajax，一个没用。
3.  https://gitee.com/ciguoguo/file-remark


#### 示例
![输入图片说明](Snipaste_2024-10-18_22-44-55.jpg)