Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP! Volto Light Theme Training docs. #861

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ mastering-plone-5/index
voltohandson/index
voltoaddons/index
volto_customization/index
volto-light-theme/index
effective-volto/index
testing/index
theming/index
Expand Down
11 changes: 11 additions & 0 deletions docs/volto-light-theme/adding-installing-new-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
myst:
html_meta:
"description": "Adding Installing New Block"
"property=og:description": "Adding Installing New Block"
"property=og:title": "Adding Installing New Block"
"keywords": "Plone, Volto, Training"
---


# Adding Installing New Block
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
70 changes: 70 additions & 0 deletions docs/volto-light-theme/creating-new-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
myst:
html_meta:
'description': 'Learn How to customize the Footer of the page'
'property=og:description': 'Learn How to customize the Footer of the page'
'property=og:title': 'Footer customization'
'keywords': 'Plone, Volto, Training, Theme, Footer'
---

# Creating New Project
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved

First you have to install the cookieplone
```
pipx install cookieplone

```

After that you have to run it to create the project.

```
pipx run cookieplone
```

It is going to ask you multiple question. If you happy with default keep pressing enter. Otherwise overwrite this according to your needs.


```
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
[1/17] Project Title (Project Title): my-vlt-project
[2/17] Project Description (A new project using Plone 6.): My Project
[3/17] Project Slug (Used for repository id) (my-vlt-project): my-project
[4/17] Project URL (without protocol) (my-project.example.com): my-project.example.com
[5/17] Author (Plone Foundation): <your name>
[6/17] Author E-mail ([email protected]):
[7/17] Should we use prerelease versions? (No):
[8/17] Plone Version (6.0.13):
[9/17] Volto Version (18.0.0):
[10/17] Python Package Name (my.project):
[11/17] Volto Addon Name (volto-my-project):
```

After creating project you have to build the volto project.

Run
```
make install
``

This will install all your backend as well as frontend project.

For running backend you have to run

```
make backend-start

```

For running frontend

```
make frontend-start

```

Please commit your inital commit by running

```
git add .
git commit -m 'initial-commit' --no-verify
```
Walk throught the boiler plate and explain them.
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
32 changes: 32 additions & 0 deletions docs/volto-light-theme/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
myst:
html_meta:
"description": "Volto Light Theme"
"property=og:description": "Volto Light Theme"
"property=og:title": "Volto Light Theme"
"keywords": "Plone, Volto, Training"
---

(volto-light-theme-label)=

# Volto Light Theme

About
: Learn how to properly use the volto-light-theme in your project.

Level
: Beginner level
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved


```{toctree}
:caption: Volto Light Theme
:maxdepth: 1
:numbered: true

creating-new-project
installing-vlt
adding-installing-new-block
theming
question-answer

```
42 changes: 42 additions & 0 deletions docs/volto-light-theme/installing-vlt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
myst:
html_meta:
"description": "Installing Volto Light Theme"
"property=og:description": "Installing Volto Light Theme"
"property=og:title": "Installing Volto Light Theme"
"keywords": "Plone, Volto, Training"
---

# Installing Volto Light Theme

First for installing volto light theme.

Go to your addon project. It is present in frontend/packages/volto-my-project and install volto-light-theme


```
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
pnpm install @kitconcept/volto-light-theme

iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
```

After installing vlt you will see this diff with some additional but this one is most important.
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved

```
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
diff --git a/frontend/packages/volto-my-project/package.json b/frontend/packages/volto-my-project/package.json
iRohitSingh marked this conversation as resolved.
Show resolved Hide resolved
index e256491..373386e 100644
--- a/frontend/packages/volto-my-project/package.json
+++ b/frontend/packages/volto-my-project/package.json
@@ -26,7 +26,9 @@
"release-major-alpha": "release-it major --preRelease=alpha",
"release-alpha": "release-it --preRelease=alpha"
,
- "dependencies": {},
+ "dependencies": {
+ "@kitconcept/volto-light-theme": "^5.0.1"
+ },
"peerDependencies":
"react": "18.2.0",
"react-dom": "18.2.0"

```

10 changes: 10 additions & 0 deletions docs/volto-light-theme/question-answer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
myst:
html_meta:
"description": "Questions And Answer"
"property=og:description": "Questions And Answer"
"property=og:title": "Questions And Answer"
"keywords": "Plone, Volto, Training"
---

# Questions And Answer
10 changes: 10 additions & 0 deletions docs/volto-light-theme/theming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
myst:
html_meta:
"description": "Theming"
"property=og:description": "Theming"
"property=og:title": "Theming"
"keywords": "Plone, Volto, Training"
---

# Theming
Loading