Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update theming.md #6966

Closed
wants to merge 1 commit into from
Closed

Update theming.md #6966

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/theming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ As of Jan 2017, skins are not fully supported; riot is the only available skin.
To define a theme for Riot:

1. Pick a name, e.g. `teal`. at time of writing we have `light` and `dark`.
2. Fork `src/skins/vector/css/themes/dark.scss` to be teal.scss
3. Fork `src/skins/vector/css/themes/_base.scss` to be _teal.scss
4. Override variables in _teal.scss as desired. You may wish to delete ones
2. Run `npm install` in the root of the project.
3. Fork `node_modules/matrix-react-sdk/res/themes/light/css/dark.scss` to be teal.scss
4. Fork `node_modules/matrix-react-sdk/res/themes/light/css/_base.scss` to be _teal.scss
5. Override variables in _teal.scss as desired. You may wish to delete ones
which don't differ from _base.scss, to make it clear which are being
overridden. If every single colour is being changed (as per _dark.scss)
then you might as well keep them all.
5. Add the theme to the list of entrypoints in webpack.config.js
6. Add the theme to the list of themes in matrix-react-sdk's UserSettings.js
7. Sit back and admire your handywork.
6. Add the theme to the list of entrypoints in webpack.config.js
7. Add the theme to the list of themes in matrix-react-sdk's UserSettings.js
8. Sit back and admire your handywork.

In future, the assets for a theme will probably be gathered together into a
single directory tree.