mirror of
https://github.com/alice-lg/alice-lg.git
synced 2024-05-11 05:55:03 +00:00
updated documentation
This commit is contained in:
33
README.md
33
README.md
@ -113,6 +113,39 @@ prior to building the RPM.
|
||||
make remote_rpm BUILD_SERVER=rpmbuild.example.com SYSTEM_INIT=upstart
|
||||
|
||||
|
||||
## Customization
|
||||
|
||||
Alice now supports custom themes!
|
||||
In your alice.conf, you now can specify a theme by setting:
|
||||
|
||||
[theme]
|
||||
path = /path/to/my/alice-theme
|
||||
|
||||
with the optional parameter (the "mountpoint" of the theme)
|
||||
url_base = /theme
|
||||
|
||||
|
||||
You can put assets (images, fonts, javscript, css) in
|
||||
this folder.
|
||||
|
||||
Stylesheets and Javascripts are automatically included in
|
||||
the client's html and are served from the backend.
|
||||
|
||||
Alice provides early stages of an extension API, which is for now
|
||||
only used to modify the content of the welcome screen,
|
||||
by providing a javascript in your theme containing:
|
||||
|
||||
```javascript
|
||||
Alice.updateContent({
|
||||
welcome: {
|
||||
title: "My Awesome Looking Glass",
|
||||
tagline: "powered by Alice"
|
||||
}
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
For an example check out: https://github.com/alice-lg/alice-theme-example
|
||||
|
||||
## Hacking
|
||||
|
||||
|
Reference in New Issue
Block a user