Provide the content for the Diazo theming part #1870
+170
−18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Fix broken references - `link.svg` - `_inc/_install-browser-reqs-volto.md` * Fix linkcheck to bobtemplates * Update tip submodules/volto * Fix link
* Fix broken references - `link.svg` - `_inc/_install-browser-reqs-volto.md` * Fix linkcheck to bobtemplates * Update tip submodules/volto * Fix link
erral
force-pushed
the
erral-diazo-docs
branch
from
133787b to
676f204
Compare
- Add note update getting help for choosing a theming method
stevepiercy
requested changes
Feb 24, 2025
|
|
||
| ## Create an add-on package | ||
|
|
||
| To create a Diazo theme, you need to create an add-on package with [`plonecli`](https://github.com/plone/plonecli). |
There was a problem hiding this comment.
What are the pre-requisites to running plonecli?
There was a problem hiding this comment.
I have reworded this stating that you don't need to install plonecli, and you can run it using pipx, like we run cookieplone: (pipx run plonecli)
| ## How to theme using Diazo | ||
|
|
||
| You can start with the provided {file}`rules.xml` file. | ||
| You will need to write your own rules to bring the dynamic content from Plone into the theme. |
There was a problem hiding this comment.
How will I write any rules, when there is no reference documentation linked here?
There was a problem hiding this comment.
The reference of writing those rules is at https://docs.diazo.org/en/latest/basic.html
There was a problem hiding this comment.
I have added a link to Diazo docs.
| For instance, you may need to put together the main menu, the language change, and the search box. | ||
| Sometimes it is easier to override the corresponding template in Plone, build the new HTML structure there, and replace one thing in the {file}`rules.xml` file than trying to write complex Diazo rules or writing XSLT. | ||
|
|
||
| The size of the {file}`rules.xml` file and the number of rules it contains can negatively impact the performance of your site. |
There was a problem hiding this comment.
That won't be a problem, since there is no reference to how to write these rules. 🙃
explain the purpose of each file created when addin a theme
Link to Diazo docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Can be seen as part of #1645
📚 Documentation preview 📚: https://plone6--1870.org.readthedocs.build/