boost/unordered-ui-bundle
2
0
Fork 0
mirror of https://github.com/boostorg/unordered-ui-bundle.git synced 2026-01-19 04:42:15 +00:00
Code Issues Projects Releases Wiki Activity

document the site.homeUrl property in the UI model; clarify how it differs from site.url and siteRootPath

Browse Source
This commit is contained in:
Dan Allen
2022-01-13 18:55:53 -07:00
parent 2c2f7f597b
commit c4855c05aa
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/modules/ROOT/pages/templates.adoc
View File

@@ -36,6 +36,7 @@ s| [[site]]site
| site.url
| The base URL of the site, if specified in the playbook.
If a site start page is defined, the visitor will be redirected from this location to the start page.
| site.path
| The pathname (i.e., subpath) of the site.url under which the site is hosted (e.g., /docs).
@@ -47,6 +48,9 @@ Can be prepended to `page.url` to create a root-relative URL for a page (e.g., `
| site.title
| The title of the site.
| site.homeUrl
| The URL that points directly to the start (aka home) page of the site.
| site.components
| A map of all the components in the site, keyed by component name.
Properties of each component include name, title, url, latest, and versions.
@@ -177,6 +181,7 @@ s| env
s| siteRootPath
| The relative path to the root of the published site.
If a site start page is defined, the visitor will be redirected from this location to the start page.
s| uiRootPath
| The relative path to the root directory of the UI.