Update documentation (#270)
* docs: update screenshots * docs: resize custom filter images * docs: update cover image * docs: move FEATURES into README.md * docs: fix spacing * docs: update grammar
DecafDev
GitHub
76
FEATURES.md
|
|
@ -1,76 +0,0 @@
|
|||
# Features
|
||||
|
||||
Features are what the software should do.
|
||||
|
||||
## User features
|
||||
|
||||
"This software should allow a user to..."
|
||||
|
||||
| Name | Tag |
|
||||
| ---------------------------------------------------------------- | ------------------------ |
|
||||
| Render files in grid view | #view |
|
||||
| Render files in list view | #view |
|
||||
| Filter files by folder | #filter |
|
||||
| Filter files by favorite property | #filter |
|
||||
| Render files by pagination | #view |
|
||||
| Sort by title: asc, desc | #sort |
|
||||
| Sort by modification date: asc, desc | #sort |
|
||||
| Filter by creation date: 1 day, 1 week, 2 weeks | #filter |
|
||||
| Filter by modification date: 1 day, 1 week, 2 weeks | #filter |
|
||||
| Filter by a frontmatter property | #filter |
|
||||
| Filter by a group of frontmatter properties | #filter |
|
||||
| Reorder the view list | #reorder |
|
||||
| Reorder property group list | #reorder #property-group |
|
||||
| Filter by search | #filter |
|
||||
| Add property filter group | #create |
|
||||
| Delete a property filter group | #delete #property-filter |
|
||||
| Match when property doesn't exist toggle | #filter #property-filter |
|
||||
| Add a property filter | #create #property-filter |
|
||||
| Delete a property filter | #delete #property-filter |
|
||||
| Select a condition for property filters | #filter #property-filter |
|
||||
| Select and/or operators for property filters | #filter #property-filter |
|
||||
| Search for tag when clicked | #search |
|
||||
| Search for property when clicked | #search |
|
||||
| Left/right buttons to allow a user to scroll between tags | #accessibility |
|
||||
| Show file preview when mouse hovers link and ctrl/cmd is pressed | #accessibility #preview |
|
||||
| Set title wrapping: normal, break-word | #render #settings |
|
||||
| Set page size | #render #settings |
|
||||
| Set property for modification date | #filter #settings |
|
||||
| Set properties for creation date | #filter #settings |
|
||||
| Set a url property | #settings |
|
||||
| Set a favorite property | #settings |
|
||||
| Set custom text properties | #settings |
|
||||
| Set the log level | #settings |
|
||||
| Move focus with left and right arrows | #accessibility |
|
||||
| Filter by folder | #filter |
|
||||
| Filter by file name | #filter |
|
||||
| Filter by file content | #filter |
|
||||
| License key for premium features | #settings |
|
||||
| Add sticky groups | #filter |
|
||||
| Disable filters condtionally | #filter |
|
||||
| Left/right buttons to allow a user to scroll between groups | #accessibility |
|
||||
| Duplicate a filter rule | #filter |
|
||||
| Random sort | #filter |
|
||||
| Add file icons | #filter |
|
||||
| Add file icon setting | #setting |
|
||||
|
||||
## Event callbacks
|
||||
|
||||
Responses to an action that happens outside of the vault view.
|
||||
|
||||
| Source action | Response action |
|
||||
| ------------------------- | ---------------- |
|
||||
| File is deleted | Refresh the view |
|
||||
| Folder is deleted | Refresh the view |
|
||||
| File is renamed | Refresh the view |
|
||||
| Folder is renamed | Refresh the view |
|
||||
| File is modified | Refresh the view |
|
||||
| Plugin setting is changed | Refresh the view |
|
||||
|
||||
## Routine tasks
|
||||
|
||||
Tasks that are preformed on a reoccurring basis.
|
||||
|
||||
| Name | Frequency |
|
||||
| ------------------------------ | -------------- |
|
||||
| Update time values for filters | Every 1 minute |
|
||||
109
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Obsidian Vault Explorer
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -22,6 +22,7 @@ Vault Explorer is a work in progress. Please check the GitHub repository and doc
|
|||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Premium](#premium)
|
||||
- [Features](#features)
|
||||
- [Network use](#network-use)
|
||||
- [Contributing](#contributing)
|
||||
- [Support](#support)
|
||||
|
|
@ -31,29 +32,43 @@ Vault Explorer is a work in progress. Please check the GitHub repository and doc
|
|||
|
||||
### Grid view
|
||||
|
||||
|
||||
|
||||
|
||||
### List view
|
||||
|
||||
|
||||
|
||||
|
||||
### Folder filter
|
||||
### Feed view
|
||||
|
||||
<img src="readme/feature-folder-filter.png" width="300">
|
||||
|
||||
|
||||
### Time filter
|
||||
### Custom filter
|
||||
|
||||
<img src="readme/feature-time-filter.png" width="300">
|
||||
<img src="readme/custom-filter.png" width="500">
|
||||
|
||||
<br/>
|
||||
|
||||
<img src="readme/custom-filter-options-1.png" width="500">
|
||||
|
||||
<br/>
|
||||
|
||||
<img src="readme/custom-filter-options-2.png" width="500">
|
||||
|
||||
### Favorites
|
||||
|
||||
|
||||
|
||||
### Timestamp filter
|
||||
|
||||
|
||||
|
||||
### Sort filter
|
||||
|
||||
<img src="readme/feature-sort-filter.png" width="300">
|
||||
|
||||
|
||||
### Property filter
|
||||
### Search filter
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -72,6 +87,76 @@ Click the compass button on the left-hand sidebar to open the vault explorer vie
|
|||
|
||||
Premium features are available to users who purchase a [Vault Explorer license](https://vaultexplorer.com/docs/premium/).
|
||||
|
||||
## Features
|
||||
|
||||
| Name | Categories | Documented |
|
||||
| ----------------------------------------------------------------- | ------------------ | ---------- |
|
||||
| Move focus with left and right arrows | Accessibility | ✅ |
|
||||
| See an image placeholder on the grid card | Cover image | |
|
||||
| Load an external image url | Cover image | |
|
||||
| Load a social media image from url | Cover image | |
|
||||
| Load an wiki link image from the frontmatter | Cover image | |
|
||||
| Load an embedded image from the markdown content | Cover image | |
|
||||
| Cache social media images | Cover image | |
|
||||
| Filter files by favorite property | Favorites filter | ✅ |
|
||||
| Favorites support for non-markdown files | Favorites filter | ✅ |
|
||||
| Add to favorites button in context menu | Favorites filter | ✅ |
|
||||
| Remove from favorites button in context menu | Favorites filter | ✅ |
|
||||
| See a favorite icon in the grid card | Favorites filter | |
|
||||
| Reorder the filter group list | Filter group | ✅ |
|
||||
| Add a filter group | Filter group | ✅ |
|
||||
| Delete a filter group | Filter group | ✅ |
|
||||
| Set a filter group as sticky | Filter group | ✅ |
|
||||
| Unset a filter group as sticky | Filter group | ✅ |
|
||||
| Right click to edit a filter group item | Filter group | |
|
||||
| Add a filter rule | Filter rule | ✅ |
|
||||
| Delete a filter rule | Filter rule | ✅ |
|
||||
| Duplicate a filter rule | Filter rule | ✅ |
|
||||
| Match when property doesn't exist toggle | Filter rule | |
|
||||
| Filter files by folder | Filter rule | |
|
||||
| Filter by frontmatter property | Filter rule | ✅ |
|
||||
| Select a condition | Filter rule | ✅ |
|
||||
| Select a logical operator: `and`, `or` | Filter rule | ✅ |
|
||||
| Filter files by folder | Filter rule | |
|
||||
| Filter files by file content | Filter rule | |
|
||||
| Filter files by file name | Filter rule | |
|
||||
| Enable/disable a filter rule | Filter rule | ✅ |
|
||||
| Set the log level | Logging | ✅ |
|
||||
| Filter by search | Search filter | |
|
||||
| Set page size | Setting | ✅ |
|
||||
| Set property for modification date | Setting | ✅ |
|
||||
| Set property for creation date | Setting | ✅ |
|
||||
| Set a url property | Setting | ✅ |
|
||||
| Set a favorite property | Setting | ✅ |
|
||||
| Set custom text property | Setting | ✅ |
|
||||
| Toggle file icons | Setting | ✅ |
|
||||
| Change the filter groups wrap | Setting | |
|
||||
| Enable/disable loading the social media image | Setting | |
|
||||
| Change the collapse style for feed content | Setting | |
|
||||
| Remove H1 from feed content | Setting | |
|
||||
| Remove markdown from feed content | Setting | |
|
||||
| Enable/disable tags on a list item | Setting | |
|
||||
| Change the plugin configuration folder | Setting, Data | |
|
||||
| Clear the social media cache | Setting, Data | |
|
||||
| Change the feed content line clamp for small screens | Setting, Feed view | |
|
||||
| Change the feed content line clamp for medium screens | Setting, Feed view | |
|
||||
| Change the feed content line clamp for large screens | Setting, Feed view | |
|
||||
| Enter a license key | Setting, License | ✅ |
|
||||
| Sort by title: `asc`, `desc` | Sort order | ✅ |
|
||||
| Sort by modification date: `asc`, `desc` | Sort order | ✅ |
|
||||
| Randomly sort files | Sort order | ✅ |
|
||||
| Filter by creation date: `1 day`, `1 week`, `2 weeks` | Timestamp filter | ✅ |
|
||||
| Filter by modification date: `1 day`, `1 week`, `2 weeks` | Timestamp filter | ✅ |
|
||||
| See vault files in a grid view | View | ✅ |
|
||||
| See vault files in a list view | View | ✅ |
|
||||
| See vault files in a feed view | View | ✅ |
|
||||
| Change the view list order | View | |
|
||||
| Limit displayed files with pagination | View | |
|
||||
| Search for a tag when clicked | View | |
|
||||
| See a file preview when mouse hovers link and ctrl/cmd is pressed | View | |
|
||||
| Search for property when clicked | View | |
|
||||
| See files icons next to the file name | View | ✅ |
|
||||
|
||||
## Network use
|
||||
|
||||
For general usage of the plugin, Vault Explorer does not make any network requests.
|
||||
|
|
|
|||
BIN
readme/cover.png
Normal file
|
After Width: | Height: | Size: 1 MiB |
BIN
readme/custom-filter-options-1.png
Normal file
|
After Width: | Height: | Size: 451 KiB |
BIN
readme/custom-filter-options-2.png
Normal file
|
After Width: | Height: | Size: 394 KiB |
BIN
readme/custom-filter.png
Normal file
|
After Width: | Height: | Size: 409 KiB |
BIN
readme/favorites-filter.png
Normal file
|
After Width: | Height: | Size: 3.2 MiB |
|
Before Width: | Height: | Size: 236 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 233 KiB |
|
Before Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 310 KiB |
|
Before Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 121 KiB |
BIN
readme/feed-view.png
Normal file
|
After Width: | Height: | Size: 338 KiB |
BIN
readme/grid-view.png
Normal file
|
After Width: | Height: | Size: 3.5 MiB |
BIN
readme/list-view.png
Normal file
|
After Width: | Height: | Size: 403 KiB |
|
Before Width: | Height: | Size: 918 KiB |
BIN
readme/search-filter.png
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
readme/sort-filter.png
Normal file
|
After Width: | Height: | Size: 1.6 MiB |
BIN
readme/timestamp-filter.png
Normal file
|
After Width: | Height: | Size: 1.6 MiB |