kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Improved custom wiki sidebar docs

This commit is contained in:
Andreas Kämmerle 2018-08-02 22:51:04 +02:00 committed by Toon Claes
parent 743508bfa5
commit 0a08fb3cd1
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/user/project/wiki/index.md
View File

@ -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.