marcia-patch-2 #11

Merged
sarah merged 15 commits from marcia/docs.cwtch.im:marcia-patch-2 into staging 2024-06-03 19:41:45 +00:00
Member
No description provided.
marcia added 3 commits 2024-05-29 18:56:14 +00:00
sarah requested changes 2024-05-29 19:05:29 +00:00
@ -11,3 +11,3 @@
:::
Cwtch now supports customized Cwtch themes. Themes can be loaded via the [Settings Pane](https://docs.cwtch.im/docs/settings/).
### Good news, now you can create your own Cwtch light and dark themes with a simple template!
Owner

This shouldn't be a title heading.

This shouldn't be a title heading.
@ -14,0 +13,4 @@
### 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
Owner

this link needs to be updated. It's root should be "//themes/"

this link needs to be updated. It's root should be "//themes/"
@ -14,0 +15,4 @@
#### 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
* Load the test theme through the settings pane. Settings > Import theme , select the “test” folder and click on “select folder”
Owner

Make "Settings" a link to the settings page (see the previous version of this file for an example)

Make "Settings" a link to the settings page (see the previous version of this file for an example)
@ -14,0 +19,4 @@
* 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!
Owner

Make this instructions.pdf file a link (and included it in this PR)

Make this instructions.pdf file a link (and included it in this PR)
marcia marked this conversation as resolved
@ -14,0 +22,4 @@
* 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/
Owner

Per OP Policy we don't generally make recommendations for any third party tools.

Per OP Policy we don't generally make recommendations for any third party tools.
@ -14,0 +34,4 @@
* 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!!!
Owner

Consider "Don't forget to save!"

Consider "Don't forget to save!"
@ -14,0 +37,4 @@
* Hit save!!!
#### 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”
Owner

In markdown you can emphasis text (make it bold) by surrounding it with asterix's e.g. bold - see https://docusaurus.io/docs/markdown-features#standard-features for more formatting options.

In markdown you can emphasis text (make it bold) by surrounding it with asterix's e.g. **bold** - see https://docusaurus.io/docs/markdown-features#standard-features for more formatting options.
marcia marked this conversation as resolved
@ -14,0 +44,4 @@
* 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
Owner
Make feedback a link to https://docs.cwtch.im/docs/contribute/testing#submitting-feedback
marcia added 1 commit 2024-05-29 20:39:16 +00:00
sarah requested changes 2024-06-03 17:01:02 +00:00
@ -13,1 +13,3 @@
Cwtch now supports customized Cwtch themes. Themes can be loaded via the [Settings Pane](https://docs.cwtch.im/docs/settings/).
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:
Owner

This should not be a heading / consider rewording this

This should not be a heading / consider rewording this
@ -14,0 +13,4 @@
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/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)
Owner

all these links should be pointing to "https://docs.cwtch.im/" as the root as that is where they will be once the website is compiled

all these links should be pointing to "https://docs.cwtch.im/" as the root as that is where they will be once the website is compiled
@ -14,0 +21,4 @@
* 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:**
Owner

This likely makes more sense as a heading instead of bolded.

This likely makes more sense as a heading instead of bolded.
@ -14,0 +36,4 @@
* Don't forget to save!
**Testing your new theme:**
Owner

This makes more sense as a heading

This makes more sense as a heading
@ -14,0 +39,4 @@
**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!
Owner

The apostrophe here is a unicode variant rather than the ascii encoded '

The apostrophe here is a unicode variant rather than the ascii encoded `'`
marcia added 1 commit 2024-06-03 19:40:33 +00:00
sarah approved these changes 2024-06-03 19:41:38 +00:00
sarah merged commit ebdc9ad785 into staging 2024-06-03 19:41:45 +00:00
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: cwtch.im/docs.cwtch.im#11
No description provided.