Skip to content

Commit b4f7714

Browse files
Merge branch 'main' into slider-flag
2 parents 1de2870 + fd84424 commit b4f7714

1 file changed

Lines changed: 100 additions & 26 deletions

File tree

docs/how-to-guides/install.md

Lines changed: 100 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,22 @@ myst:
88
---
99

1010
# Install
11+
12+
## Frontend
13+
1114
`@kitconcept/volto-light-theme` is a Volto add-on.
1215
It should be installed as any other add-on using the `dependencies` key in your project's add-on file {file}`packages/<name_of_your_project_addon>/package.json`.
1316

17+
```{code-block} json
18+
:caption: {file}`packages/<name_of_addon>/package.json`
19+
{
20+
"dependencies": {
21+
"@kitconcept/volto-light-theme": "^8.0.0-alpha.0",
22+
// other dependencies
23+
}
24+
}
25+
```
26+
1427
You should also configure `@kitconcept/volto-light-theme` as a Volto add-on using the `addons` key in your project add-on file {file}`packages/<name_of_your_project_addon>/package.json`.
1528

1629
```json
@@ -23,18 +36,6 @@ You should also configure `@kitconcept/volto-light-theme` as a Volto add-on usin
2336
],
2437
```
2538

26-
Since `@kitconcept/volto-light-theme` is also a theme add-on, you should declare it in your project's {file}`volto.config.js`.
27-
28-
```js
29-
const addons = ['<name_of_your_project_addon>'];
30-
const theme = '@kitconcept/volto-light-theme';
31-
32-
module.exports = {
33-
addons,
34-
theme,
35-
};
36-
```
37-
3839
```{versionadded} 18.29.1
3940
```
4041
```{versionadded} 19.0.0-alpha.10
@@ -60,7 +61,19 @@ The following snippet shows example configuration.
6061
}
6162
```
6263

63-
## VLT recommended add-ons
64+
If you are in an older version of Volto, since `@kitconcept/volto-light-theme` is also a theme add-on, you should declare it in your project's {file}`volto.config.js` `theme` key.
65+
66+
```js
67+
const addons = ['<name_of_your_project_addon>'];
68+
const theme = '@kitconcept/volto-light-theme';
69+
70+
module.exports = {
71+
addons,
72+
theme,
73+
};
74+
```
75+
76+
### VLT recommended add-ons
6477

6578
`@kitconcept/volto-light-theme` supports all core blocks and it also supports blocks from selected Volto add-ons.
6679
The recommended add-ons are listed in the {doc}`../reference/recommended-addons` section.
@@ -80,19 +93,20 @@ Nevertheless, you can choose to install only those you want to use.
8093
:caption: {file}`packages/<name_of_addon>/package.json`
8194
{
8295
"dependencies": {
83-
"@eeacms/volto-accordion-block": "^10.4.6",
84-
"@kitconcept/volto-banner-block": "^1.1.0",
85-
"@kitconcept/volto-bm3-compat": "^1.0.0-alpha.1",
86-
"@kitconcept/volto-button-block": "^4.0.0-alpha.0",
87-
"@kitconcept/volto-carousel-block": "^2.0.0-alpha.3",
88-
"@kitconcept/volto-dsgvo-banner": "^2.5.1",
89-
"@kitconcept/volto-heading-block": "^2.5.0",
90-
"@kitconcept/volto-highlight-block": "^5.0.0-alpha.2",
91-
"@kitconcept/volto-introduction-block": "^1.1.0",
92-
"@kitconcept/volto-logos-block": "^3.0.0-alpha.1",
93-
"@kitconcept/volto-separator-block": "^4.2.1",
94-
"@kitconcept/volto-slider-block": "^6.4.0",
95-
"@plonegovbr/volto-social-media": "^2.0.0-alpha.10"
96+
"@eeacms/volto-accordion-block": "^12.0.0",
97+
"@kitconcept/volto-banner-block": "^1.2.0",
98+
"@kitconcept/volto-bm3-compat": "^1.0.0-alpha.1",
99+
"@kitconcept/volto-button-block": "5.0.0-alpha.2",
100+
"@kitconcept/volto-calendar-block": "^1.0.0-alpha.9",
101+
"@kitconcept/volto-carousel-block": "^3.0.0-alpha.1",
102+
"@kitconcept/volto-dsgvo-banner": "^4.0.0-alpha.2",
103+
"@kitconcept/volto-heading-block": "^2.5.0",
104+
"@kitconcept/volto-highlight-block": "^5.0.0-alpha.2",
105+
"@kitconcept/volto-introduction-block": "^1.4.1",
106+
"@kitconcept/volto-logos-block": "^4.0.0-alpha.1",
107+
"@kitconcept/volto-separator-block": "^5.0.0-alpha.0",
108+
"@kitconcept/volto-slider-block": "^7.0.0-alpha.1",
109+
"@plonegovbr/volto-social-media": "^3.0.0-alpha.0"
96110
// other dependencies
97111
}
98112
}
@@ -131,3 +145,63 @@ Find the full list of the {doc}`../reference/recommended-addons`.
131145
```{note}
132146
If you don't want to use any of the recommended add-ons, then remove them and don't declare them as add-ons in your project, leaving only those that you want.
133147
```
148+
149+
## Backend
150+
151+
VLT has a Plone backend add-on that is required to be installed in your Plone backend.
152+
The backend add-on is called `kitconcept.voltolighttheme` you need to take these steps to install it:
153+
154+
1. Pull it as a dependency in your Plone backend add-on {file}`pyproject.toml`:
155+
156+
```toml
157+
[project]
158+
dependencies = [
159+
<!-- Other deps here -->
160+
"kitconcept.voltolighttheme = "^8.0.0"
161+
]
162+
```
163+
164+
2. Run `make install` in your Plone backend folder to install the dependency.
165+
166+
3a. Install it in your Plone backend site using the Add-ons control panel.
167+
168+
3b. or alternatively, if you have an existing site and do you want to install it programmatically using GenericSetup in `metadata.xml`:
169+
170+
```xml
171+
<?xml version="1.0" encoding="utf-8"?>
172+
<metadata>
173+
<version>20260714001</version>
174+
<dependencies>
175+
<dependency>profile-kitconcept.voltolighttheme:default</dependency>
176+
</dependencies>
177+
</metadata>
178+
```
179+
180+
then in `upgrades.zcml`:
181+
182+
```xml
183+
<genericsetup:upgradeStep
184+
title="Install kitconcept.voltolighttheme dependency"
185+
description="Install the newly required kitconcept.voltolighttheme profile."
186+
source="1000"
187+
destination="20260714001"
188+
handler=".upgrades.install_kitconcept_voltolighttheme"
189+
profile="your.package:default"
190+
/>
191+
```
192+
193+
and in `upgrades.py`:
194+
195+
```python
196+
from plone import api
197+
198+
def install_kitconcept_voltolighttheme(context):
199+
"""Install the kitconcept.voltolighttheme profile."""
200+
setup_tool = api.portal.get_tool("portal_setup")
201+
setup_tool.runAllImportStepsFromProfile("profile-kitconcept.voltolighttheme:default")
202+
```
203+
204+
## Site customizations
205+
206+
If you want to add the VLT behaviors to your Plone site, you can follow the instructions in the {doc}`../conceptual-guides/site-customization` section.
207+
They will allow you to customize the header, footer, and theme of your Plone site using easy knobs in the content type applied to (Plone site/Subsite).

0 commit comments

Comments
 (0)