Update docs/contribute/themes.md

This commit is contained in:
marcia 2024-05-29 20:39:13 +00:00
parent 321287153d
commit e2275633b1
1 changed files with 8 additions and 8 deletions

View File

@ -10,19 +10,19 @@ We are still finalizing the exact format of the theme files. Please consider thi
:::
### Good news, now you can create your own Cwtch light and dark themes with a simple template!
Good news, now you can create your own Cwtch light and dark themes with a simple template!
#### Follow these easy steps to create a brand new theme:
* Download [this test folder](https://git.openprivacy.ca/cwtch.im/cwtch-ui/src/branch/trunk/assets/themes), which includes: theme.yml (editable file) and test.png (background image) and Instructions.pdf
* Download [this test folder](https://git.openprivacy.ca/marcia/docs.cwtch.im/src/branch/staging/static/test_theme), which includes: [theme.yml](https://git.openprivacy.ca/marcia/docs.cwtch.im/src/branch/staging/static/test_theme/theme.yml) (editable file), [test.png](https://git.openprivacy.ca/marcia/docs.cwtch.im/src/branch/staging/static/test_theme/test.png) (background image) and [Instructions.pdf](https://git.openprivacy.ca/marcia/docs.cwtch.im/src/branch/staging/static/test_theme/Instructions.pdf)
* Load the test theme through the settings pane. Settings > Import theme , select the “test” folder and click on “select folder”
* Load the test theme through the settings pane. [Settings](https://docs.cwtch.im/docs/settings/) > Import theme , select the “test” folder and click on “select folder”
* Now you have the test theme installed and you can edit the .yml file
* Check the instructions.pdf file for more in depth instructions on how to edit the .yml file and what each part of the code changes!
#### Editing the .yml file:
* Pick your colours using any web tool, we recommend https://mycolor.space/
**Editing the .yml file:**
* Pick your colours using any web tool
* Pick a colour to be your accent colour and select all the other colours based on that one
@ -34,9 +34,9 @@ We are still finalizing the exact format of the theme files. Please consider thi
* Replace test.png for a transparent png you want to use as a background, if you dont want a background image, disable theme images on settings>theme images
* Hit save!!!
* Don't forget to save!
#### Testing your new theme:
**Testing your new theme:**
* Re-load the test theme through the settings pane. Settings> Import theme , select the “test” folder and click on “select folder”
* Repeat until youre satisfied with your new theme!
@ -44,7 +44,7 @@ We are still finalizing the exact format of the theme files. Please consider thi
* If you're an advanced user, feel free to edit the .yml code beyond selecting colours!
As always, let us know if this is working for you, we'd love to hear your feedback
As always, let us know if this is working for you, [we'd love to hear your feedback](https://docs.cwtch.im/docs/contribute/testing/#submitting-feedback)