From a6dfcafdab7798f27ee810135c8f7e8cd78b3852 Mon Sep 17 00:00:00 2001 From: Deluan Date: Sat, 11 Apr 2020 13:13:53 -0400 Subject: [PATCH] Update themes doc, link to documentation site --- ui/src/themes/README.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/ui/src/themes/README.md b/ui/src/themes/README.md index c76c0b4a4..9d61a12aa 100644 --- a/ui/src/themes/README.md +++ b/ui/src/themes/README.md @@ -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/