From 8a7690c4471cad1e497c13f37aef40117cd88488 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Thu, 22 Aug 2019 13:11:48 -0600 Subject: [PATCH] add hint about how to disable the page.editUrl property --- docs/modules/ROOT/pages/templates.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/templates.adoc b/docs/modules/ROOT/pages/templates.adoc index f74a28e..378fb6b 100644 --- a/docs/modules/ROOT/pages/templates.adoc +++ b/docs/modules/ROOT/pages/templates.adoc @@ -106,7 +106,9 @@ If there are multiple versions of the component, the canonical URL is the qualif If there's only a single version of the component, the canonical URL is the qualified URL of the current page. | page.editUrl -| The URL to edit the current page, typically on GitHub. +| The URL to edit the current page (typically a web-based editor on the git host). +This value will not be set if the repository requires authentication or the repository URL embeds credentials. +A quick way to disable this property (and thus the "Edit this Page" link) is to start the repository URL with `\https://git@`. | page.home | Indicates whether the current page is the home page of the site. -- 2.11.0