Version pagelinks (google#1054)

* Allow versioned docs to point to the same page in the different versions If the version_menu_pagelinks config option is true, then link in the drop-down menu of the versioned docs points to the current page in the other version, instead of the main page. This can be useful if the document doesn't change much between the different versions. Note that if the current page doesn't exist in the other version, the link will be broken. * Adds version_menu_pagelinks to the userguide * Typo fix Co-authored-by: LisaFC <[email protected]>
dapr-cn · Jun 30, 2022 · 8c018e3 · 8c018e3
1 parent 73440c9
commit 8c018e3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/layouts/partials/navbar-version-selector.html b/layouts/partials/navbar-version-selector.html
@@ -2,7 +2,11 @@
 	{{ .Site.Params.version_menu }}
 </a>
 <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
+	{{ $path := "" }}
+	{{ if .Site.Params.version_menu_pagelinks }}
+		{{ $path = .Page.RelPermalink }}
+	{{ end }}
 	{{ range .Site.Params.versions }}
-	<a class="dropdown-item" href="{{ .url }}">{{ .version }}</a>
+	<a class="dropdown-item" href="{{ .url }}{{ $path }}">{{ .version }}</a>
 	{{ end }}
 </div>
diff --git a/userguide/content/en/docs/Adding content/versioning.md b/userguide/content/en/docs/Adding content/versioning.md
@@ -84,6 +84,11 @@ version_menu: 'Releases'
 {{< /tab >}}
 {{< /tabpane >}}
 
+If you set the `version_menu_pagelinks` parameter to `true`, then links in the version drop-down menu 
+point to the current page in the other version, instead of the main page.
+This can be useful if the document doesn't change much between the different versions.
+Note that if the current page doesn't exist in the other version, the link will be broken.
+
 You can read more about Docsy menus in the guide to
 [navigation and search](/docs/adding-content/navigation/).