add tip about how to remove site.path from site.url using helper
authorDan Allen <dan@opendevise.com>
Sat, 16 May 2020 09:54:08 +0000 (03:54 -0600)
committerDan Allen <dan@opendevise.com>
Sat, 16 May 2020 09:54:08 +0000 (03:54 -0600)
docs/modules/ROOT/pages/templates.adoc

index eb53e2d..3facf8b 100644 (file)
@@ -42,7 +42,8 @@ s| [[site]]site
 
 | site.path
 | The pathname (i.e., subpath) of the site.url under which the site is hosted (e.g., /docs).
-Only set if site.url is defined.
+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`)
 (since Antora 2.1)
 
 | site.title