Skip to content

Commit e74871d

Browse files
docs: update readme
1 parent cdd57d8 commit e74871d

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Revitron Automad Theme
22

3-
This theme is an [Automad](https://automad.org) port of the [Revitron Sphinx theme](https://github.com/revitron/revitron-sphinx-theme). Check out the Revitron [documentation](https://revitron.readthedocs.io/) as a live demo. Note that this port might differ from the original Sphinx theme in small details.
3+
This theme is an [Automad](https://automad.org) port of the [Revitron Sphinx theme](https://github.com/revitron/revitron-sphinx-theme). Check out the Revitron [documentation](https://revitron-ui.readthedocs.io/) as a live demo. Note that this port might differ from the original Sphinx theme in small details.
44

55
![](https://raw.githubusercontent.com/marcantondahmen/media-files/master/themes/revitron/default.png)
66

7+
- [Templates](#templates)
8+
- [Options](#options)
9+
- [Custom Color Schemes](#custom-color-schemes)
10+
711
## Templates
812

913
This theme provides two different templates — a [default](https://revitron.readthedocs.io/en/latest/get-started.html) including a sidebar navigation and a [landing page](https://revitron.readthedocs.io/) template. Content can be added and edited using the block editor.
@@ -19,6 +23,7 @@ The following variables are available:
1923
| --- | --- | --- |
2024
| + Main | The main content block area | Page |
2125
| Brand | The brand HTML, SVG or text to be used as logo | - |
26+
| Custom Properties | Custom color definitions to [override](#custom-color-schemes) theme colors | - |
2227
| Image Logo | The path to your logo - this variable should be defined globally in the shared data section | - |
2328
| Image Logo Mobile | An alternative logo for smaller devices | - |
2429
| Items Footer | Additional markup to be added to page's footer | - |
@@ -34,4 +39,13 @@ The following variables are available:
3439
| Search Results Title | The title for the search results page | Shared |
3540
| Syntax Theme | The name of the syntax theme for [highlight.js](https://highlightjs.org/static/demo/), the default is 'ascetic'. | Shared |
3641
| Url Github | The URL to a related GitHub repository | Shared |
37-
| Url Pagelist | The URL for the search results page | Shared |
42+
| Url Pagelist | The URL for the search results page | Shared |
43+
44+
## Custom Color Schemes
45+
46+
The color scheme in this theme is controlled by a set of custom CSS [properties](https://github.com/revitron/revitron-sphinx-theme/blob/master/src/sass/_colors.sass). Therefore it is very easy to override things without actually modifying templates or other files.
47+
You can instead add your custom color definitions to the `Custom Properties` field in the **Global Data and Settings** section of the dashboard. For example the background color can be changed by adding the following line to the `Custom Properties` field:
48+
49+
--bg: hsl(50, 40%, 95%);
50+
51+
A full list of available properties can be found in the [Revitron Sphinx Theme](https://github.com/revitron/revitron-sphinx-theme/blob/master/src/sass/_colors.sass) repository.

0 commit comments

Comments
 (0)