Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelGB committed Apr 27, 2022
1 parent fd9849a commit 56a07a1
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The information you add or edit will be saved into the target obsidian note.
- Global filters
![GlobalFilter.gif](docs/resources/GlobalFilter.gif)

#### Event Driven
- (*NEW*) Configurable select column with `group_folder_column` property. This column will be used to group the notes into subfolders with the same cell value. The subfolder will be created if it does not exist.
![GroupFolderColumn.gif](docs/resources/GroupFolderColumn.gif)

### Whats inside the database view?
Database view read the yaml configuration inside .md file and render a react DOM.

Expand All @@ -40,8 +44,11 @@ Mandatory:
- **label**: name of the column
Optional:
- **position**: order of the columns
#### Local configuration


#### Local configuration
- **enable_show_state**: show react table state at bottom of the page. It has a default value & local value of each database.
- **group_folder_column**: name of the column used to group the notes into subfolders with the same cell value. The subfolder will be created if it does not exist. It must be a select column type.
```markdown
---

Expand Down Expand Up @@ -75,9 +82,16 @@ columns:
accessor: Calification
label: Calification
key: Calification
position: 5
view_state:
input: select
accessor: view_state
key: view_state
label: view_state
position: 4
config:
enable_show_state: false
group_folder_column: view_state
%%>
```

Expand Down
Binary file added docs/resources/GroupFolderColumn.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "dbfolder",
"name": "DB Folder",
"version": "0.0.6",
"version": "0.0.7",
"minAppVersion": "0.14.6",
"description": "Folder with the capability to store and retrieve data from a folder like database",
"author": "RafaelGB",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-dbfolder",
"version": "0.0.6",
"version": "0.0.7",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
"main": "main.js",
"scripts": {
Expand Down

0 comments on commit 56a07a1

Please sign in to comment.