Skip to content

Commit

Permalink
Clarify installation requirements and appearance options
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelCDL committed Jan 29, 2025
1 parent 33ad430 commit b41a2c5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ View sample at https://cdlib.github.io/klaro-ui

## Requirements

- Git
- Node version 20 or above
- NPM version 10 or above
- Klaro source and a valid config file
- Klaro source script and config file
- Modifying the loading of third-party scripts in your application's HTML

## Installation

1. Follow the steps in [Getting Started](https://klaro.org/docs/getting-started) within the Klaro documentation.
1. Follow the steps in [Getting Started](https://klaro.org/docs/getting-started) within the Klaro documentation. You can use the [example Klaro config](https://github.com/cdlib/klaro-ui/blob/main/js/klaro-config.js) in this repo as a boilerplate for your Klaro instance.

2. Within the `src` URL of the Klaro script (after the config script), replace the URL ending in **klaro.js** with the "no CSS" version:

Expand All @@ -39,7 +39,7 @@ The module **klaro-ui** is now installed in your application's **node_modules**

Klaro UI doesn't include any typefaces. The Klaro text will include the font defined for the document.

The Klaro UI default stylesheet renders a light colored theme when a user's system appearance is set to light colors and a dark colored theme when set to dark colors.
The default stylesheet **klaro-ui.css** renders a light colored theme when a user's system appearance is set to light colors and a dark colored theme when set to dark colors. This default appearance is recommended, as it's more accessible for users than the static light and dark themes listed below.

For only the light colored theme, use **klaro-ui-light.css** within **klaro-ui/dist**.

Expand Down

0 comments on commit b41a2c5

Please sign in to comment.