Wiki: docs: How to create side navigation?

Created on 8 Aug 2017  路  6Comments  路  Source: Requarks/wiki

In the Wiki.js documentation I have seen that it's possible to create a very nice looking side navigation (like "All Pages" -> "Wiki.js" -> "Admin Guide"). How can this be achieved? I already created directories and subdirectories in my GitHub repository (which syncs with my Wiki.js installation) but these directories don't show up as clickable menu items. 馃槩

This is what I want to build:

unbenannt

help

Most helpful comment

can we keep this sidebar fixed ? when you open a page it disappears is there is a way to keep the folder structure ?

All 6 comments

Directories are not actual pages. You must create a page inside for them to appear in the navigation.

I created a Markdown page inside the newly created directories but they didn't show up in my navigation. 馃槩

I looked up this directory to get a grasp of what's going on. In the screenshot it's shown that the sidebar navigation is named "Admin Guide" but the folder inside the "Requarks/docs" repo is just called "admin-guide", so how does the translation (from "admin-guide" directory to "Admin Guide" navigation) happen?

Your folders (and files) must follow the kebab case naming if you create them outside Wiki.js. Otherwise they won't be indexed properly.

Names are automatically converted back to normal case when displayed. e.g. admin-guide becomes Admin Guide

Thanks for the info!

Instead of naming my directory "Curriculum", I named it "the-curriculum" and it was picked up by the automatic GitHub synchronization. 馃憤

can we keep this sidebar fixed ? when you open a page it disappears is there is a way to keep the folder structure ?

@el3ctrician i would love this feature too - but i dont think it makes sense to discuss it here - open a new issue/feautre request

the best solution would be to have an option to fix it or show breadcrumbs top/bottom of the page
(mayb this is planned for 2.0 anyways)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ccolella-mdc picture ccolella-mdc  路  3Comments

thinkh picture thinkh  路  4Comments

den1622 picture den1622  路  3Comments

p-se picture p-se  路  3Comments

SharkProgramming picture SharkProgramming  路  4Comments