From 40abae111b97a78f7625298ac31c60450d0d4093 Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Thu, 5 Sep 2024 19:01:41 -0500 Subject: [PATCH] docs(#181): document relative paths & globs --- docs/customization.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index c7e35f4..58e9f7a 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -16,13 +16,19 @@ This file should contain a JSON object that can have the following optional keys: - **`"styles"`**\ - A path to a single custom style sheet, or an array of multiple style sheets - applied in order. These will be applied after Vivify's [default - styles](./static/) are applied so that there are always sensible fallbacks but - you can override everything. + A path to a single custom style sheet, or an array of paths for multiple style + sheets applied in order. The paths can be absolute, start with a tilde (`~`) + for your home directory, or be relative to your config file's directory. The + paths can also include [glob patterns](https://www.npmjs.com/package/glob).\ + The styles will be applied after Vivify's [default styles](./static/) are + applied so that there are always sensible fallbacks but you can override + everything. - **`"scripts"`**\ A path to a single custom JavaScript to inject into the viewing pages, or an - array of multiple custom scripts. + array of paths for multiple custom scripts injected in order. The paths can be + absolute, start with a tilde (`~`) for your home directory, or be relative to + your config file's directory. The paths can also include [glob + patterns](https://www.npmjs.com/package/glob). - **`"dirListIgnore"`**\ A path to a file with globs to ignore in Vivify's directory viewer, or an array of multiple paths to ignore files. The syntax here is the same as in