aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/04_Frontend/02_Design.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/developers/04_Frontend/02_Design.md')
-rw-r--r--docs/en/developers/04_Frontend/02_Design.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/en/developers/04_Frontend/02_Design.md b/docs/en/developers/04_Frontend/02_Design.md
index 625fede28..74b92dee2 100644
--- a/docs/en/developers/04_Frontend/02_Design.md
+++ b/docs/en/developers/04_Frontend/02_Design.md
@@ -4,7 +4,8 @@
**As of writing (02-02-2021), support for themes as extensions is under development.**
-The easiest way to create a theme is by copying and modifying the base theme (or another of the pre-installed themes). The base theme can be found in [/p/themes/base-theme](https://github.com/FreshRSS/FreshRSS/tree/master/p/themes/base-theme). Themes require:
+The easiest way to create a theme is by copying and modifying the base theme (or another of the pre-installed themes). The base theme can be found in [/p/themes/base-theme](https://github.com/FreshRSS/FreshRSS/tree/edge/p/themes/base-theme). Themes require:
+
- a **metadata.json** file to describe the theme.
- a **loader.gif** file to use as a loading icon (assuming .loading's background has not been overridden)
- an **icons** folder containing .svg, .ico, and .png files to override existing icons
@@ -16,14 +17,15 @@ The easiest way to create a theme is by copying and modifying the base theme (or
RTL (right-to-left) support for languages such as Hebrew and Arabic is handled through CSSJanus. To generate an RTL CSS file from your standard file, use `make rtl`. Be sure to commit the resulting file (filename.rtl.css).
-# Overriding icons
+## Overriding icons
To replace the default icons, add an "icons" folder to your theme's folder. Use files with the same name as the default icon to override them.
-# Template file
+## Template file
-metadata.json
-```
+`metadata.json`
+
+```json
{
"name": "Theme name",
"author": "Theme author",
@@ -33,4 +35,4 @@ metadata.json
}
```
-An example of a css theme file can be found at [/p/themes/base-theme/base.css](https://github.com/FreshRSS/FreshRSS/blob/master/p/themes/base-theme/base.css)
+An example of a css theme file can be found at [/p/themes/base-theme/base.css](https://github.com/FreshRSS/FreshRSS/blob/edge/p/themes/base-theme/base.css)