Skip to content

Commit ac98ddc

Browse files
committed
docs: show full version number in sidebar
Change the sidebar customization so that the full version (e.g. v0.2.0) is displayed, instead of the truncated "releae branch version" (e.g. v0.2) in the top left corner of the page. The items in the version menu are unchanged and will still show the shorter form. Cherry picked from node-feature-discovery repo commit 4d19e1ab85b6cf4c6a2f6e556bf04654e4fb238e.
1 parent f1a05b7 commit ac98ddc

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/_config.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ remote_theme: rundocs/[email protected]
4545
version: master
4646
display_version_list: true
4747

48-
# Release is used to make external links to point to the correct blobs in the
49-
# Github repo
48+
# Release is the full released version number. Used to make external links to
49+
# point to the correct blobs in the Github repo. This is also the version shown
50+
# in the sidebar (top left corner of the page)
5051
release: master
5152

5253
# Container image which to point to in the documentation

docs/_includes/class/sidebar-wrap.liquid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<i class="fa fa-home"></i> {{ site.title }}
77
</a>
88
</div>
9-
<span class="version">{{ site.version }}</span>
9+
<span class="version">{{ site.release }}</span>
1010
<form class="search pt-2" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
1111
<input class="form-control input-block input-sm" type="text" name="q" placeholder="{{ __.search_docs | default: 'Search docs...' }}">
1212
</form>

0 commit comments

Comments
 (0)