From ef1778e051e007f08f9188a479d04fdf95a57d21 Mon Sep 17 00:00:00 2001 From: Zero~Informatique Date: Thu, 13 Feb 2020 18:13:55 +0100 Subject: documentation --- example/readme.md | 5 +++-- ldgallery.1.md | 6 ------ viewer/readme.md | 4 ++++ 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 ------- ``` -./example/src +./example/out -- the output directory for the compiled version of the gallery +./example/src -- source directory with pictures, configuration, tags and metadata ├── _DSC8808-1.jpg -- a picture ├── _DSC8808-1.jpg.yaml -- its associated sidecar metadata file ├── Glacier 3000 -- a directory grouping gallery items @@ -17,5 +18,5 @@ Content │   ├── _DSC5475.jpg.yaml │   ├── _DSC5542.jpg │   └── _DSC5542.jpg.yaml -├── gallery.yaml -- gallery settings file +└── gallery.yaml -- gallery settings file ``` 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 compiler.pictureMaxResolution.height : Maximum height in pixels of the picture items, unlimited by default. -viewer.defaultSearchMode [TODO] -: Default search view mode ("highlight" or "filter"). Defaults to "filter". - viewer.defaultSearchQuery [TODO] : Default search query string. @@ -138,9 +135,6 @@ viewer.defaultSortOrder [TODO] viewer.tagGroups[].tag [TODO] : Tag prefix defining the tag group. -viewer.tagGroups[].order [TODO] -: Order in which to display tag groups. - viewer.tagGroups[].colour [TODO] : Colour associated to the tag group. 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 ``` ### Compiles and hot-reloads for development + +The viewer DevServer will serve the compiled version of the example gallery by default. +To override, create a file .env.development.local + ``` npm run serve ``` -- cgit v1.2.3