mirrors
/
navidrome
mirror of https://github.com/navidrome/navidrome.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update themes doc, link to documentation site

This commit is contained in:
Deluan 2020-04-11 13:13:53 -04:00
parent 8f2c7b7913
commit a6dfcafdab
1 changed files with 2 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
ui/src/themes/README.md
View File

@ -1,20 +1,2 @@
## Creating New Themes
Themes in Navidrome are simple [Material-UI themes](https://material-ui.com/customization/theming/). They are basic JS
objects, that allow you to override almost every visual aspect of Navidrome's UI.
#### Steps to create a new theme:
1) Create a new JS file in this folder that exports an object containing your theme. Create the theme based on the
ReactAdmin/Material UI documentation below. See the existing themes for examples.
2) Add a `themeName` property to your theme. This will be displayed in the theme selector
3) Add your new theme to the `ui/src/themes/index.js` file
4) Start the application, your new theme should now appear as an option in the theme selector
Before submitting a pull request to include your theme in Navidrome, please test your theme thoroughly and make sure
it is formated with the [Prettier](https://prettier.io/) rules found in the project (`ui/src/.prettierrc.js`)
#### Resources for Material-UI theming
* Start reading [ReactAdmin documentation](https://marmelab.com/react-admin/Theming.html#writing-a-custom-theme)
* Color Tool: https://material-ui.com/customization/color/#official-color-tool
To create and contribute with new themes, please refer to
https://www.navidrome.org/docs/developers/creating-themes/