Skip to content
This repository was archived by the owner on Jul 28, 2025. It is now read-only.

Commit ea67b3c

Browse files
committed
mejorando docu
1 parent c48a0a2 commit ea67b3c

File tree

1 file changed

+94
-27
lines changed

1 file changed

+94
-27
lines changed

docs/docs/about.md

Lines changed: 94 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ You can edit directly the yaml configuration inside the `.md` file or use the ta
55
### Information
66
Details about your database
77

8-
- **name**: Name asociated to your database (TODO)
9-
- **description**: extra information explaining the purpose of the database (TODO)
8+
- **name**: Name asociated to your database.
9+
- **description**: extra information explaining the purpose of the database. Will be displated in preview mode.
1010
### Database
1111
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.
1212

@@ -18,9 +18,14 @@ Mandatory:
1818
- **label**: name of the column
1919

2020
Optional:
21-
2221
- **position**: order of the columns
22+
- **options**: list of options for the column (only for select type)
23+
24+
Configuration:
2325
- **isInline**: true if you want to edit the field inline mode
26+
- **enable_media_view**: true if you want to see the media view (only for text type)
27+
- **media_width**: width of the media view
28+
- **media_height**: height of the media view
2429

2530

2631
### Local configuration
@@ -31,37 +36,70 @@ Each database has a yaml local configuration that is read when you open the data
3136

3237
database-plugin: basic
3338

39+
---
40+
<%%
41+
---
42+
43+
database-plugin: basic
44+
3445
---
3546
<%%
3647
name: Entertaiment
3748
description: All media contain that I consume
3849
columns:
39-
view_state:
40-
input: select
41-
accessor: view_state
42-
key: view_state
43-
label: view_state
44-
position: 3
45-
isInline: false
4650
Calification:
4751
input: select
4852
accessor: Calification
4953
label: Calification
5054
key: Calification
51-
position: 7
52-
isInline: true
55+
position: 5
56+
enable_media_view: true
57+
media_width: 100
58+
media_height: 100
59+
isInline: false
60+
isSorted: false
61+
isSortedDesc: false
62+
options:
63+
- { label: "⭐️⭐️⭐️⭐️⭐️", backgroundColor: "hsl(0,62.66650406270436%,57.196614999999994%)"}
64+
- { label: "⭐️⭐️⭐️⭐️", backgroundColor: "hsl(305, 95%, 90%)"}
65+
- { label: "⭐️⭐️⭐️", backgroundColor: "hsl(116, 95%, 90%)"}
66+
- { label: "⭐️⭐️", backgroundColor: "hsl(185, 95%, 90%)"}
67+
- { label: "⭐️", backgroundColor: "hsl(78, 95%, 90%)"}
68+
config:
69+
enable_media_view: true
70+
media_width: 100
71+
media_height: 100
72+
isInline: false
5373
director:
5474
input: text
5575
accessor: director
5676
label: director
5777
key: director
5878
position: 4
79+
enable_media_view: true
80+
media_width: 100
81+
media_height: 100
82+
isInline: false
83+
isSorted: false
84+
isSortedDesc: true
85+
config:
86+
enable_media_view: true
87+
media_width: 100
88+
media_height: 100
89+
isInline: false
5990
Year:
6091
input: number
6192
accessor: Year
6293
label: Year
6394
key: Year
64-
position: 6
95+
position: 7
96+
isSorted: false
97+
isSortedDesc: false
98+
config:
99+
enable_media_view: true
100+
media_width: 100
101+
media_height: 100
102+
isInline: false
65103
__file__:
66104
key: __file__
67105
input: markdown
@@ -70,37 +108,66 @@ columns:
70108
isMetadata: true
71109
skipPersist: false
72110
csvCandidate: true
73-
isInline: false
74111
position: 1
112+
config:
75113
title:
76114
input: text
77115
accessor: title
78116
label: title
79117
key: title
80-
position: 5
81-
isInline: false
118+
position: 6
119+
isSorted: false
120+
isSortedDesc: true
121+
config:
122+
enable_media_view: true
123+
media_width: 100
124+
media_height: 100
125+
isInline: false
82126
Watched_at:
83127
input: calendar
84128
accessor: Watched_at
85129
key: Watched_at
86130
label: Watched_at
131+
position: 3
132+
isSorted: true
133+
isSortedDesc: true
134+
config:
135+
enable_media_view: true
136+
media_width: 100
137+
media_height: 100
138+
isInline: false
139+
viewed:
140+
input: checkbox
141+
accessor: viewed
142+
key: viewed
143+
label: viewed
87144
position: 2
88-
__created__:
89-
key: __created__
90-
input: calendar
91-
label: Created
92-
accessor: __created__
93-
isMetadata: true
94-
skipPersist: false
95-
csvCandidate: true
145+
enable_media_view: true
146+
media_width: 100
147+
media_height: 100
96148
isInline: false
149+
media_togle_promise: true
150+
isSorted: false
151+
isSortedDesc: false
152+
config:
153+
enable_media_view: true
154+
media_width: 100
155+
media_height: 100
156+
isInline: false
157+
media_togle_promise: true
97158
config:
98159
enable_show_state: false
99-
group_folder_column: view_state
160+
group_folder_column: none
100161
remove_field_when_delete_column: true
101-
show_metadata_created: true
162+
show_metadata_created: false
102163
show_metadata_modified: false
164+
media_settings:
165+
enable_media_view: true
166+
width: 100
167+
height: 100
168+
show_metadata_tasks: true
169+
source_data: current_folder
170+
source_form_result: zettelcaster/meet
103171
filters:
104-
- {field: Year, operator: GREATER_THAN_OR_EQUAL,value: 2000}
105172
%%>
106173
```

0 commit comments

Comments
 (0)