xuquan-nikkkki_FolderFile-Splitter-Plugin/README-CN.md

# FolderFile Splitter 插件

[English](./README.md) | [中文](./README.zh.md)

**FolderFile Splitter** 是一款 Obsidian 插件。它通过将文件夹和文件列表分开展示，从而提供了一种全新的文件管理方式。插件的界面交互受 Apple Notes 设计理念的启发，旨在提供一种更简洁、更直观的方式来浏览和整理笔记。

## 功能
- **分屏视图**：将文件夹和文件分开展示，帮助你更好地了解笔记的结构。
- **改进的导航**：轻松在文件夹和文件间导航，提升工作效率。
- **增强的文件管理**：通过简化界面，集中管理最重要的内容，提升可用性。
    ![file management example](./src/assets/images/file_management.gif)
- **布局模式切换**：可在水平分屏和垂直分屏布局之间切换，以适应你的工作习惯。
    ![layout mode toggle](./src/assets/images/layout_mode.gif)
- **自定义排序**：允许用户自定义文件和文件夹的顺序，包括将特定项目置顶以便快速访问。
    ![manual sort files and folders](./src/assets/images/manual_sort.gif)
- **置顶文件和文件夹**：轻松将常用文件或文件夹置顶，以便更快访问和更好组织。
   ![pin files and folders](./src/assets/images/pin.gif)
- **主题适配**：自动适配当前 Obsidian 主题，确保一致且美观的视觉体验。
   ![theme adaptation](./src/assets/images/theme_adpation.png)

## 安装
### 方法 1：从 Obsidian 社区插件安装（推荐）
1. **搜索插件**
    - 在 Obsidian 中，进入 **设置 → 社区插件**。
    - 点击 **浏览**，然后搜索 **FolderFile Splitter**。
2. 安装并启用插件
    - 点击 **安装**，然后返回 **已安装的插件** 部分。
    - 启用 **FolderFile Splitter** 即可开始使用。

### 方法 2：手动安装

1. **下载插件**
   - 进入本仓库的 [Releases](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin/releases) 页面。
   -  载最新的 `.zip` 压缩包。

2. **解压并放入插件文件夹**
   - 解压下载的 .zip 文件
   - 将解压后的插件文件夹移动到你的 Obsidian Vault 目录下的 `.obsidian/plugins` 文件夹中。
   - 如果找不到 .obsidian 文件夹，可能是因为它是隐藏的。可以通过以下快捷键显示隐藏文件：
     - **Windows**：在文件资源管理器中按 `Ctrl + Shift + .`
     - **Mac**：在 Finder 中按 `Cmd + Shift + .`

3. **在 Obsidian 中启用插件**
    - 打开 Obsidian，进入 **设置 → 社区插件（Community Plugins）**。
    - 启用刚刚安装的插件。

## 卸载

要卸载插件，只需在 Obsidian 插件设置中禁用或删除插件。如果你需要重置所有设置，可以在设置菜单中清除插件设置。

## What's Next

- **自定义设置**：允许用户自定义插件行为，例如设置添加新文件或文件夹时的默认位置、定制文件/文件夹排序等。
- **移动端支持**：为 Obsidian 的移动端适配插件，确保跨设备的无缝文件管理。
- **标签管理**：引入标签管理功能，让文件组织系统更加灵活。

## 更新日志

- **v0.1.0**：初始版本，包含文件夹/文件分屏视图和改进的导航功能。
- **v0.2.0**：新增自定义排序、置顶文件和文件夹功能，以及主题适配。

## 反馈与问题

如果你遇到任何 bug 或有功能建议，欢迎你在这个 [GitHub 仓库](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin)中提交问题。你的反馈对于改进 FolderFile Splitter 插件非常重要！

## 支持插件开发
如果你喜欢这个插件，或者觉得它对你有帮助，可以通过以下方式支持我：

<img src="./src/assets/images/赞赏码.png" alt="赞赏码" width="260px" />

你的支持是我持续更新和优化插件的动力！非常感谢！💖