document the site.path property in the UI model
authorDan Allen <dan@opendevise.com>
Sun, 25 Aug 2019 10:33:34 +0000 (04:33 -0600)
committerDan Allen <dan@opendevise.com>
Sun, 25 Aug 2019 10:33:34 +0000 (04:33 -0600)
docs/modules/ROOT/pages/templates.adoc

index caf08a9..508903e 100644 (file)
@@ -34,6 +34,11 @@ Here's an overview of the available UI model:
 | site.url
 | The base URL of the site, if specified.
 
+| site.path
+| The pathname segment of the site.url under which the site is hosted (e.g., /docs).
+If the site.url is not specified, or does not contain a path, this value is empty.
+(since Antora 2.1)
+
 | site.title
 | The title of the site.