add documentation for fonts in custom theme

This commit is contained in:
Bruno Windels 2020-06-24 14:55:57 +02:00
parent f3ef2aba2b
commit 2ce448943b
1 changed files with 12 additions and 0 deletions

View File

@ -41,6 +41,16 @@ eg. in config.json:
{ {
"name": "Electric Blue", "name": "Electric Blue",
"is_dark": false, "is_dark": false,
"fonts": {
"faces": [
{
"font-family": "Inter",
"src": [{"url": "/fonts/Inter.ttf", "format": "ttf"}]
}
],
"general": "Inter, sans",
"monospace": "'Courrier New'"
},
"colors": { "colors": {
"accent-color": "#3596fc", "accent-color": "#3596fc",
"primary-color": "#368bd6", "primary-color": "#368bd6",
@ -84,3 +94,5 @@ eg. in config.json:
`username-colors` is expected to contain 8 colors. `avatar-background-colors` is expected to contain 3 colors. Both values are optional and have fallbacks from the built-in theme. `username-colors` is expected to contain 8 colors. `avatar-background-colors` is expected to contain 3 colors. Both values are optional and have fallbacks from the built-in theme.
These are exposed as `--username-colors_0`, ... and `--avatar-background-colors_0`, ... respectively in CSS. These are exposed as `--username-colors_0`, ... and `--avatar-background-colors_0`, ... respectively in CSS.
All properties in `fonts` are optional, and will default to the standard Riot fonts.