feat: update readme to add install from community plugins method

This commit is contained in:
Xu Quan 2025-02-26 15:35:59 +08:00
parent 2277b5c379
commit c68abcf7ec
2 changed files with 50 additions and 43 deletions

View file

@ -7,34 +7,36 @@
**FolderFile Splitter** 是一款 Obsidian 插件。它通过将文件夹和文件列表分开展示,从而提供了一种全新的文件管理方式。插件的界面交互受 Apple Notes 设计理念的启发,旨在提供一种更简洁、更直观的方式来浏览和整理笔记。
## 功能
- **分屏视图**:将文件夹和文件分开展示,帮助你更好地了解笔记的结构。
- **改进的导航**:轻松在文件夹和文件间导航,提升工作效率。
- **增强的文件管理**:通过简化界面,集中管理最重要的内容,提升可用性。
- **分屏视图**:将文件夹和文件分开展示,帮助你更好地了解笔记的结构。
- **改进的导航**:轻松在文件夹和文件间导航,提升工作效率。
- **增强的文件管理**:通过简化界面,集中管理最重要的内容,提升可用性。
![插件预览](./src/assets/images/split-views.jpg)
## 安装
### 方法 1从 Obsidian 社区插件安装(推荐)
1. **搜索插件**
- 在 Obsidian 中,进入 **设置 → 社区插件**
- 点击 **浏览**,然后搜索 **FolderFile Splitter**
2. 安装并启用插件
- 点击 **安装**,然后返回 **已安装的插件** 部分。
- 启用 **FolderFile Splitter** 即可开始使用。
### 方法:手动安装
### 方法 2:手动安装
1. **下载插件**
- 进入本仓库的 [Releases](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin/releases) 页面。
- 下载最新的 `.zip` 压缩包。
- 进入本仓库的 [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 + .`
- 解压下载的 .zip 文件
- 将解压后的插件文件夹移动到你的 Obsidian Vault 目录下的 `.obsidian/plugins` 文件夹中。
- 如果找不到 .obsidian 文件夹,可能是因为它是隐藏的。可以通过以下快捷键显示隐藏文件:
- **Windows**:在文件资源管理器中按 `Ctrl + Shift + .`
- **Mac**:在 Finder 中按 `Cmd + Shift + .`
3. **在 Obsidian 中启用插件**
- 打开 Obsidian进入 **设置 → 社区插件Community Plugins**
- 启用刚刚安装的插件。
- 打开 Obsidian进入 **设置 → 社区插件Community Plugins**
- 启用刚刚安装的插件。
## 卸载
@ -42,14 +44,14 @@
## What's Next
- **自定义设置**:允许用户自定义插件行为,例如设置添加新文件或文件夹时的默认位置、定制文件/文件夹排序等。
- **移动端支持**:为 Obsidian 的移动端适配插件,确保跨设备的无缝文件管理。
- **拖拽功能**:启用文件和文件夹的拖拽功能,简化重组操作。
- **标签管理**:引入标签管理功能,让文件组织系统更加灵活。
- **自定义设置**:允许用户自定义插件行为,例如设置添加新文件或文件夹时的默认位置、定制文件/文件夹排序等。
- **移动端支持**:为 Obsidian 的移动端适配插件,确保跨设备的无缝文件管理。
- **拖拽功能**:启用文件和文件夹的拖拽功能,简化重组操作。
- **标签管理**:引入标签管理功能,让文件组织系统更加灵活。
## 更新日志
- **v0.0.1**:初始版本,包含文件夹/文件分屏视图和改进的导航功能。
- **v0.0.1**:初始版本,包含文件夹/文件分屏视图和改进的导航功能。
## 反馈与问题

View file

@ -6,31 +6,36 @@
## Features
- **Split View**: Separates folders and files into different panels for a better overview of your note structure.
- **Improved Navigation**: Navigate through folders and files effortlessly without losing track of your location.
- **Enhanced File Management**: Focus on what matters most with a streamlined interface that prioritizes usability.
- **Split View**: Separates folders and files into different panels for a better overview of your note structure.
- **Improved Navigation**: Navigate through folders and files effortlessly without losing track of your location.
- **Enhanced File Management**: Focus on what matters most with a streamlined interface that prioritizes usability.
![plugin preview](./src/assets/images/split-views.jpg)
## Install
### Method 1: Install from Obsidian Community Plugins (Recommended)
1. **Search for the Plugin**
- In Obsidian, navigate to **Settings → Community Plugins**.
- Click **Browse** and search for **FolderFile Splitter**.
2. **Install and Enable the Plugin**
- Click **Install**, then go back to the **Installed Plugins** section.
- Enable **FolderFile Splitter** to start using it.
### Method: Manual Installation
### Method 2: Manual Installation
1. **Download the Plugin**
- Go to the [Releases](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin/releases) section of this repository.
- Download the latest `.zip` file.
- Go to the [Releases](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin/releases) section of this repository.
- Download the latest `.zip` file.
2. **Extract and Place in the Plugins Folder**
- Extract the downloaded `.zip` file.
- Move the extracted plugin folder into your Obsidian vault's `.obsidian/plugins` directory.
- If you can't find the `.obsidian` folder, it might be hidden. You can enable hidden files using:
- **Windows:** Press `Ctrl + Shift + .` in File Explorer.
- **Mac:** Press `Cmd + Shift + .` in Finder.
- Extract the downloaded `.zip` file.
- Move the extracted plugin folder into your Obsidian vault's `.obsidian/plugins` directory.
- If you can't find the `.obsidian` folder, it might be hidden. You can enable hidden files using:
- **Windows:** Press `Ctrl + Shift + .` in File Explorer.
- **Mac:** Press `Cmd + Shift + .` in Finder.
3. **Enable the Plugin in Obsidian**
- Open Obsidian and go to **Settings → Community Plugins**.
- Enable the newly installed plugin.
- Open Obsidian and go to **Settings → Community Plugins**.
- Enable the newly installed plugin.
## Uninstall
@ -38,14 +43,14 @@ To uninstall the plugin, simply disable or delete it from the Obsidian plugin se
## What's Next
- **Customizable Settings**: Allow users to customize the plugins behavior, such as setting the default location for new files or folders, and customizing the sorting order of files and folders for a more personalized experience.
- **Mobile Support**: Adapt the plugin for use on Obsidian's mobile app, ensuring seamless file management across devices.
- **Drag-and-Drop**: Enable drag-and-drop functionality for files and folders to simplify reorganization.
- **Tag-Based Management**: Introduce the ability to manage files using tags for a more flexible organization system.
- **Customizable Settings**: Allow users to customize the plugins behavior, such as setting the default location for new files or folders, and customizing the sorting order of files and folders for a more personalized experience.
- **Mobile Support**: Adapt the plugin for use on Obsidian's mobile app, ensuring seamless file management across devices.
- **Drag-and-Drop**: Enable drag-and-drop functionality for files and folders to simplify reorganization.
- **Tag-Based Management**: Introduce the ability to manage files using tags for a more flexible organization system.
## Changelog
- **v0.0.1**: Initial release with folder/file split view and improved navigation.
- **v0.0.1**: Initial release with folder/file split view and improved navigation.
## Feedback & Issues