Initial release 0.1.0

This commit is contained in:
Chenyan Wang 2026-05-03 17:49:29 +08:00
commit 732fbee605
6 changed files with 2411 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 cyanwang
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

72
README.md Normal file
View file

@ -0,0 +1,72 @@
# Smart Folder View
Smart Folder View is an Obsidian plugin that turns a folder of notes into an interactive dashboard. It lets you build reusable pages with timeline and board layouts, metadata-based filters, stable color mapping, drag sorting, and saved presets.
## Features
- Build saved dashboard pages from any folder in your vault.
- Switch between timeline view and board view.
- Filter notes by frontmatter fields with multi-select controls.
- Keep page state with saved profiles, presets, and last-opened page memory.
- Drag cards to reorder items in timeline and board layouts.
- Update ordering only, or update ordering together with a target field value.
- Undo the last drag action.
- Export a page definition back into your vault.
- Use Chinese or English UI.
- Configure generated card colors from a chosen metadata field.
## Commands
- Create Smart Folder Page
- Manage Saved Pages
- Open Last Page
- Export Page
Command labels follow the plugin UI language and may appear in Chinese or English.
## How It Works
Each saved page stores:
- a source folder
- an optional template file used to infer fields
- a color field
- a sort field and sort direction
- a set of display fields
- a preferred layout mode
- an optional board grouping field
The plugin opens a dedicated custom view and renders matching notes as cards. Filter state, presets, and manual ordering are persisted locally for each page.
## Installation
### Community Plugins
After approval and publication, install Smart Folder View from Obsidian's Community Plugins browser.
### Manual Installation
1. Open your vault's plugin folder: `.obsidian/plugins/`.
2. Create a folder named `smart-folder-view`.
3. Copy `main.js`, `manifest.json`, and `styles.css` into that folder.
4. Restart Obsidian or reload plugins.
5. Enable Smart Folder View in Community Plugins.
## Development Notes
- Runtime entry: `main.js`
- Release metadata: `manifest.json`
- Version compatibility map: `versions.json`
- Local state file: `data.json` (not a release asset)
## Release Checklist
1. Update `manifest.json` version and minimum compatible Obsidian version.
2. Add the same version to `versions.json`.
3. Create a GitHub release whose tag exactly matches the plugin version, for example `0.1.0`.
4. Upload `main.js`, `manifest.json`, and `styles.css` to the release assets.
5. Submit the repository to `obsidianmd/obsidian-releases` by adding an entry to `community-plugins.json`.
## License
MIT

2300
main.js Normal file

File diff suppressed because it is too large Load diff

10
manifest.json Normal file
View file

@ -0,0 +1,10 @@
{
"id": "smart-folder-view",
"name": "Smart Folder View",
"version": "0.1.0",
"minAppVersion": "1.0.0",
"description": "Interactive folder dashboard with timeline and board views, filters, drag sorting, and saved page presets",
"author": "cyanwang",
"authorUrl": "https://github.com/sixtarocyan",
"isDesktopOnly": false
}

5
styles.css Normal file
View file

@ -0,0 +1,5 @@
/*
* Smart Folder View currently ships its view styling from main.js.
* This file is intentionally kept as a release asset placeholder so
* GitHub releases can include the standard Obsidian plugin file set.
*/

3
versions.json Normal file
View file

@ -0,0 +1,3 @@
{
"0.1.0": "1.0.0"
}