From 11d8db4c125522ef248376936d27dcc9ef3b30e8 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 18 Apr 2022 11:25:46 -0600 Subject: [PATCH] Updated README --- .github/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/README.md b/.github/README.md index ed65f83..da0012a 100644 --- a/.github/README.md +++ b/.github/README.md @@ -65,6 +65,7 @@ ass was designed with developers in mind. If you are a developer & want somethin - Usage metrics - Thumbnail support - Mimetype blocking +- Themeable viewer page - Basic multi-user support - Configurable global upload size limit (per-user coming soon) - Custom pluggable frontends using [Git Submodules] @@ -290,6 +291,21 @@ Webhooks will show the filename, mimetype, size, upload timestamp, thumbail, & a [create a new Webhook]: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +## Customizing the viewer + +If you want to customize the font or colours of the viewer page, create a file in the `share/` directory called `theme.json`. Available options are: + +| Option | Purpose | +| ------ | ------- | +| **`font`** | The font family to use; defaults to `"Josefin Sans"`. Fonts with a space should be surrounded by double quotes. | +| **`bgPage`** | Background colour for the whole page | +| **`bgViewer`** | Background colour for the viewer element | +| **`txtPrimary`** | Primary text colour; this should be your main brand colour. | +| **`txtSecondary`** | Secondary text colour; this is used for the file details. | +| **`linkHover`** | Colour of the `hover` effect for links | +| **`linkActive`** | Colour of the `active` effect for links | +| **`borderHover`** | Colour of the `hover` effect for borders; this is used for the underlining links. | + ## Custom index By default, ass directs the index route `/` to this README. Follow these steps to use a custom index: