xuquan-nikkkki_FolderFile-S.../README.md

58 lines
3 KiB
Markdown
Raw Normal View History

# FolderFile Splitter Plugin
2025-01-27 17:03:21 +00:00
2025-01-30 14:53:49 +00:00
[English](./README.md) | [中文](./README-CN.md)
**FolderFile Splitter** is an Obsidian plugin that brings a fresh approach to file management by splitting folders and files into distinct, visually separated lists. Inspired by Apple's elegant design principles, this plugin offers a cleaner, more intuitive way to browse and organize your notes.
2025-01-27 17:03:21 +00:00
## Features
2025-02-06 15:03:51 +00:00
- **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.
2025-02-06 15:03:51 +00:00
![plugin preview](./src/assets/images/split-views.jpg)
2025-01-27 17:03:21 +00:00
## 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.
2025-02-06 15:03:51 +00:00
### Method 2: Manual Installation
2025-02-06 15:03:51 +00:00
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.
2025-02-06 15:03:51 +00:00
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.
2025-02-06 15:03:51 +00:00
3. **Enable the Plugin in Obsidian**
- Open Obsidian and go to **Settings → Community Plugins**.
- Enable the newly installed plugin.
2025-01-27 17:03:21 +00:00
## Uninstall
2025-02-06 15:03:51 +00:00
2025-01-27 17:03:21 +00:00
To uninstall the plugin, simply disable or delete it from the Obsidian plugin settings. If you need to reset all settings, clear the plugin settings from the settings menu.
## What's Next
2025-02-06 15:03:51 +00:00
- **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.
2025-01-27 17:03:21 +00:00
## Changelog
- **v0.0.1**: Initial release with folder/file split view and improved navigation.
2025-01-27 17:03:21 +00:00
2025-02-06 15:03:51 +00:00
## Feedback & Issues
If you encounter any bugs or have feature suggestions, please open an issue on this [GitHub repository](https://github.com/XuQuan-nikkkki/FolderFile-Splitter-Plugin). Your feedback is invaluable in helping us improve FolderFile Splitter!