aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZero~Informatique2020-02-13 18:13:55 +0100
committerZero~Informatique2020-02-13 18:13:55 +0100
commitef1778e051e007f08f9188a479d04fdf95a57d21 (patch)
treec29727c29c66778007d5c32e336ba2aa565031f5
parent1763c8ce725098100618079553a9ec4f79386a5d (diff)
downloadldgallery-ef1778e051e007f08f9188a479d04fdf95a57d21.tar.gz
documentation
-rw-r--r--example/readme.md5
-rw-r--r--ldgallery.1.md6
-rw-r--r--viewer/readme.md4
3 files changed, 7 insertions, 8 deletions
diff --git a/example/readme.md b/example/readme.md
index 087a8bc..e455f03 100644
--- a/example/readme.md
+++ b/example/readme.md
@@ -8,7 +8,8 @@ Content
8------- 8-------
9 9
10``` 10```
11./example/src 11./example/out -- the output directory for the compiled version of the gallery
12./example/src -- source directory with pictures, configuration, tags and metadata
12├── _DSC8808-1.jpg -- a picture 13├── _DSC8808-1.jpg -- a picture
13├── _DSC8808-1.jpg.yaml -- its associated sidecar metadata file 14├── _DSC8808-1.jpg.yaml -- its associated sidecar metadata file
14├── Glacier 3000 -- a directory grouping gallery items 15├── Glacier 3000 -- a directory grouping gallery items
@@ -17,5 +18,5 @@ Content
17│   ├── _DSC5475.jpg.yaml 18│   ├── _DSC5475.jpg.yaml
18│   ├── _DSC5542.jpg 19│   ├── _DSC5542.jpg
19│   └── _DSC5542.jpg.yaml 20│   └── _DSC5542.jpg.yaml
20├── gallery.yaml -- gallery settings file 21â”── gallery.yaml -- gallery settings file
21``` 22```
diff --git a/ldgallery.1.md b/ldgallery.1.md
index 8928693..f071344 100644
--- a/ldgallery.1.md
+++ b/ldgallery.1.md
@@ -126,9 +126,6 @@ compiler.pictureMaxResolution.width
126compiler.pictureMaxResolution.height 126compiler.pictureMaxResolution.height
127: Maximum height in pixels of the picture items, unlimited by default. 127: Maximum height in pixels of the picture items, unlimited by default.
128 128
129viewer.defaultSearchMode [TODO]
130: Default search view mode ("highlight" or "filter"). Defaults to "filter".
131
132viewer.defaultSearchQuery [TODO] 129viewer.defaultSearchQuery [TODO]
133: Default search query string. 130: Default search query string.
134 131
@@ -138,9 +135,6 @@ viewer.defaultSortOrder [TODO]
138viewer.tagGroups[].tag [TODO] 135viewer.tagGroups[].tag [TODO]
139: Tag prefix defining the tag group. 136: Tag prefix defining the tag group.
140 137
141viewer.tagGroups[].order [TODO]
142: Order in which to display tag groups.
143
144viewer.tagGroups[].colour [TODO] 138viewer.tagGroups[].colour [TODO]
145: Colour associated to the tag group. 139: Colour associated to the tag group.
146 140
diff --git a/viewer/readme.md b/viewer/readme.md
index 864dcc6..3757f3e 100644
--- a/viewer/readme.md
+++ b/viewer/readme.md
@@ -8,6 +8,10 @@ npm install
8``` 8```
9 9
10### Compiles and hot-reloads for development 10### Compiles and hot-reloads for development
11
12The viewer DevServer will serve the compiled version of the example gallery by default.
13To override, create a file .env.development.local
14
11``` 15```
12npm run serve 16npm run serve
13``` 17```