diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2019-05-17 17:38:33 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-05-17 17:38:33 +0000 |
commit | 30f769f3b484a30bf46307f2cb61e104bca4350c (patch) | |
tree | ea0a6cfc6e81ee46b86c60e93179f1fedf281963 | |
parent | f4dfbb688d979a81abe26dd84af0ace875dabe5a (diff) | |
parent | 0a08fb3cd1f3ce76e384cd0b573297dd4f74fa43 (diff) | |
download | gitlab-ce-30f769f3b484a30bf46307f2cb61e104bca4350c.tar.gz |
Merge branch 'improve-wiki-custom-sidebar-docs' into 'master'
Improved custom wiki sidebar docs
See merge request gitlab-org/gitlab-ce!27888
-rw-r--r-- | doc/user/project/wiki/index.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index 95f606fd786..e3c6cd6d6ff 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -116,7 +116,9 @@ instructions. ## Customizing sidebar -By default, the wiki would render a sidebar which lists all the pages for the -wiki. You could as well provide a `_sidebar` page to replace this default -sidebar. When this customized sidebar page is provided, the default sidebar -would not be rendered, but the customized one. +On the project's Wiki page, there is a right side navigation that renders the full Wiki pages list by default, with hierarchy. + +If the Wiki repository contains a `_sidebar` page, the file of this page replaces the default side navigation. +This custom file serves to render it's custom content, fully replacing the standard sidebar. + +Support for displaying a generated TOC with a custom side navigation is planned. |