bigbuffet/bigbuffet-rw
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update customization.md to include fork awesome font reference and refresh browser reference

Browse source
This commit is contained in:
Curtis 2020-06-12 22:23:51 +00:00
parent 8c10afad3e
commit 06ea73b363
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/customization.md
View file

@ -66,6 +66,9 @@ Use of the Captcha feature on the registration page is configured during the Ple
## Site Logo, Brand Color, and Promo Panel List Items
The site logo, brand color, and promo panel list items are customized by copying `soapbox.example.json` in the `static/instance` folder to `soapbox.json` and editing that file. It is recommended that you test your edited soapbox.json file in a JSON validator, such as [JSONLint](https://jsonlint.com/), before using it.
The icon names for the promo panel list items can be source from [Fork Awesome](https://forkaweso.me/Fork-Awesome/icons/). Note that you should hover over or click a selected icon to see what the icon's real name is, e.g. `world`
The site logo, in SVG format, is rendered to be able to allow the site theme colors to appear in the less than 100% opaque sections of the logo.
The logo colors are rendered in a color that provides contrast for the site theme.
@ -73,11 +76,10 @@ The `navlinks` section of the `soapbox.json` file references the links that are
The `brandColor` in `soapbox.json` refers to the main color upon which the look of soapbox-fe is defined.
After editing your HTML files and folder names, re-create the webpack and restart the soapbox-fe service to effect the changes.
After editing your HTML files and folder names, save the file and refresh your browser.
## Favicon
The favicon is customized by dropping a favicon.png file into the `/static` folder.
Re-create the webpack and start the soapbox-fe service to effect the changes.
The favicon is customized by dropping a favicon.png file into the `/static` folder and refreshing your browser.
## About Pages
Soapbox supports any number of custom HTML pages under `yoursite.com/about/:slug`.