Skip to content

Commit

Permalink
Merge pull request #44 from ooker777/patch-1
Browse files Browse the repository at this point in the history
better formatting for mkdocs
  • Loading branch information
RafaelGB committed May 17, 2022
2 parents 5ef85ff + fdc44a5 commit 52be0d7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@ Database view read the yaml configuration inside `.md` file and render a react D
You can edit directly the yaml configuration inside the `.md` file or use the table features to edit the columns.
### Information
Details about your database

- **name**: Name asociated to your database (TODO)
- **description**: extra information explaining the purpose of the database (TODO)
### Database
The *columns* key is used to charge the correct information when you charge the react-table. Each column supports all the literals of react-table column configurations.

Mandatory:

- **input**: indicates the type of the column (text,markdown & number)
- **key**: name of obsidian field metadata in your notes (inline not supported edition yet)
- **accessor**: is the key of the data. Must be unique
- **label**: name of the column

Optional:

- **position**: order of the columns
- **isInline**: true if you want to edit the field inline mode

Expand Down Expand Up @@ -98,4 +103,4 @@ config:
filters:
- {field: Year, operator: GREATER_THAN_OR_EQUAL,value: 2000}
%%>
```
```

0 comments on commit 52be0d7

Please sign in to comment.