Updated README

pull/126/head
tycrek 3 years ago
parent 651f213351
commit 11d8db4c12
No known key found for this signature in database
GPG Key ID: 25D74F3943625263

16
.github/README.md vendored

@ -65,6 +65,7 @@ ass was designed with developers in mind. If you are a developer & want somethin
- Usage metrics - Usage metrics
- Thumbnail support - Thumbnail support
- Mimetype blocking - Mimetype blocking
- Themeable viewer page
- Basic multi-user support - Basic multi-user support
- Configurable global upload size limit (per-user coming soon) - Configurable global upload size limit (per-user coming soon)
- Custom pluggable frontends using [Git Submodules] - 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 [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 ## Custom index
By default, ass directs the index route `/` to this README. Follow these steps to use a custom index: By default, ass directs the index route `/` to this README. Follow these steps to use a custom index:

Loading…
Cancel
Save