Additional doc for templates and themes #50
Conversation
| @@ -20,7 +20,6 @@ import com.lightbend.paradox.tree.Tree.{ Forest, Location } | |||
| import com.lightbend.paradox.template.PageTemplate | |||
| import java.io.File | |||
| import java.net.URI | |||
| import java.nio.file.{ Path, Paths } | |||
There was a problem hiding this comment.
import java.nio.file.{ Path => NioPath , Paths => NioPaths }
There was a problem hiding this comment.
Probably split this commit.
| @@ -1,5 +1,4 @@ | |||
| Linking | |||
| ------- | |||
| # Linking | |||
There was a problem hiding this comment.
Change Callouts to H2 instead.
There was a problem hiding this comment.
Yes. Maybe because I'm using Pamflet that can generate combined pages and PDF, I think of the whole doc as one big markdown file.
| ```markdown | ||
| ## myTitle | ||
| ``` | ||
| and similarly for `=` and `#`. |
There was a problem hiding this comment.
Remove description of headers. And mention that the first header becomes the title of the page.
| @@ -1,5 +1,5 @@ | |||
| Snippet inclusion | |||
| ----------------- | |||
| ================= | |||
| @@ -1,21 +1,32 @@ | |||
| [st]: http://www.stringtemplate.org/ | |||
|
|
|||
| Templating | |||
| ---------- | |||
| ========== | |||
|
|
||
| The `layout` property allows to specify the layout we want to be used for this particular page. The layouts are placed by default in the `target/paradox/theme` folder, but you can create one in `src/main/paradox/_template` folder as a string template file (.st). | ||
| The `layout` property allows to specify the template we want to be used for this particular page. The templates are generated by default in paradox in the `target/paradox/theme` folder, but you can create one in `src/main/paradox/_template` folder as a string template file (.st). |
There was a problem hiding this comment.
Suggested change for the first sentence:
The layout of the page is determined by default by a template called page.st. Using layout property, we can change the layout template to something else for this particular page.
| @@ -43,9 +54,15 @@ layout: templateName | |||
| */ | |||
| ``` | |||
|
|
|||
| where `templateName` is the name of a template, more precisely the `templateName.st` file, which could either be a predefined template, or a created one in the `src/main/paradox/_template` folder. | |||
| where `templateName` is the name of a template, more precisely the `templateName.st` file, which could either be a predefined template, or a created one in the `src/main/paradox/_template` folder. The default templates generated by paradox depends on the theme used, see [this](themes.md) for more info about themes. | |||
| Theming | ||
| ======= | ||
|
|
||
| Paradox uses "theming" to generate its target files. Combined with templates within it, themes can produce a global styling of the site generated. |
There was a problem hiding this comment.
A theme is a collection of templates and other resources like css and image files that can be distributed as a web jar. Using this mechanism, multiple Paradox sites can have consistent look and feel.
| */ | ||
| ``` | ||
|
|
||
| ## How to use themes |
There was a problem hiding this comment.
In this section, just explain how to use external themes or local templates.
| ``` | ||
|
|
||
| considering you have previously created a template with the name `myDefault.st` | ||
|
|
There was a problem hiding this comment.
Here make a new section for creating a new theme.
Indicate how to deal with templates and themes and what are the possibilities with them.