add tip about using site.path to create a root-relative URL for a page
authorDan Allen <dan@opendevise.com>
Mon, 16 Aug 2021 08:25:23 +0000 (02:25 -0600)
committerDan Allen <dan@opendevise.com>
Mon, 16 Aug 2021 08:25:23 +0000 (02:25 -0600)
docs/modules/ROOT/pages/templates.adoc

index 39a259b..f2c0fce 100644 (file)
@@ -40,7 +40,8 @@ s| [[site]]site
 | site.path
 | The pathname (i.e., subpath) of the site.url under which the site is hosted (e.g., /docs).
 This value is empty if site.url is not defined, has no path segment, or matches /.
-Can be removed from the site.url value using a helper (e.g., `deleteSuffix site.url site.path`)
+Can be dropped from the site.url value using a helper (e.g., `deleteSuffix site.url site.path`)
+Can be prepended to `page.url` to create a root-relative URL for a page (e.g., `+{{{site.path}}}{{{page.url}}}+`).
 (since Antora 2.1)
 
 | site.title