Skip to content
This repository has been archived by the owner on Feb 27, 2021. It is now read-only.

Commit

Permalink
Updated themes README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Dern committed Oct 6, 2020
1 parent df1c028 commit 70d211d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 51 deletions.
4 changes: 2 additions & 2 deletions config/version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ current:
major: 0
minor: 3
patch: 19
prerelease: 1-gac4e892
prerelease: 2-gdf1c028
buildmetadata: ''
commit: ac4e89
commit: df1c02
timestamp:
year: 2020
month: 10
Expand Down
50 changes: 1 addition & 49 deletions resources/themes/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1 @@
# Cyca's themes

Cyca supports themes, and this is the directory where they should sit.

Each directory contains a theme, which consists of, at least, a ```theme.js```
file, which is tailwind's configuration used to compile theme's CSS, a
```theme.css``` file, where you will include base stylesheet:

```css
@import "../../css/app.css";
```

and a ```theme.json``` file containing meta details about your theme, such as
author, URL, etc.

Your theme can contain more resources than just tailwind's configuration. For
instance, custom fonts and icons.

Please read [tailwind's documentation](https://tailwindcss.com/docs/configuration)
for more informations.

Themes processing includings copying files from your theme's ```resources```
directory to Cyca's public directory. Please be sure to use a ```resources```
directory inside your theme if it needs such resources.

For instance, if your theme makes use of a custom font file, you can create a
```fonts``` folder inside the ```resources``` folder, and then put your font in
the ```fonts``` folder.

Please note that if you want Cyca to use custom icons, you should comply to the
following rules:

- Icons must be SVG
- All icons must be in the same file
- Icons identifiers must match the ones used in the _cyca-dark_ theme
- This file must be named "icons.svg"
- This file must be in a ```resources/images``` folder

These rules exist to ensure consistency across themes.

If you made a theme and want to share with others, you can make a
[pull request](https://github.com/RichardDern/Cyca/pulls). Your theme will be
tested and integrated to Cyca's repository.

Theme inheritance is supported. For instance, cyca-light is inherited from
cyca-dark, with replaced set of colors. cyca-dark itself is inherited from
tailwind's default configuration (```baseTheme.js```). Axiomatically, each theme
inherits from tailwind's default configuration, so you can create complexe
themes with ease, just by following tailwind's documentation.
Theme creation documentation was moved to [Cyca's website](https://www.getcyca.com/docs/how-to-create-a-theme-for-cyca/).

0 comments on commit 70d211d

Please sign in to comment.