Sidebar not being displayed and search not working when deployed to GitHub Pages

[reymon359]

Bug Report

The sidebar dissapears and the search stops working when deploying to GitHub Pages

I already submitted an issue in the plugin repo https://github.com/iPeng6/docsify-sidebar-collapse/issues/29, however I decided to submit it here too in case someone can help 😄

Steps to reproduce

• Have a look at this repo and clone it https://github.com/reymon359/collman-fruits-example
• run docsify serve docs to see how it works locally
• check https://reymon359.github.io/collman-fruits-example/#/ to compare how the issue is happening there and not locally

What is current behaviour

The sidebar is not being displayed when deployed to Github Pages

However it works locally

What is the expected behaviour

The sidebar should appear when deployed to GitHub Pages the same way it works locally

Other relevant information

• [x] Bug does still occur when all/other plugins are disabled?
• Your OS: macOS version 10.15.4 (19E266)
• Node.js version: v14.17.4
• npm/yarn version: 6.14.14 / 1.22.4
• Browser version: Brave
• Docsify version: 4
• Docsify plugins: search, docsify-sidebar-collapse, docsify-themeable, docsify-pagination, zoom-image

Please create a reproducible sandbox

Mention the docsify version in which this bug was not present (if any)

[sy-records]

You need to set the basePath

basePath: '/collman-fruits-example/',

[reymon359]

Hi there @sy-records!

Thank you for the suggestion. I tried adding the basePath: '/docsify-sidebar-collapse/', to the window.$docsify object in the repo https://github.com/reymon359/collman-fruits-example index.html file, but it didn't work. 🤔

I had a proper look at the docs and tried these too(without success):

• adding basePath: '/',
• adding basePath: '/docsify-sidebar-collapse/',
• adding relativePath: true,
• adding basePath: '/collman-fruits-example/',

In the end this one worked. However, I feel it is a bit unnecessary to add the full raw URL path.

• adding basePath: 'https://raw.githubusercontent.com/reymon359/collman-fruits-example/master/docs/',

Thank you again for the help and have a great day full of meat 🍖 ! 😄

[SumithChandran]

This method is ok if the git repo is publicly accessible. If its in an organization and is private it wont work. That's what happened to me.

I too faced the same issue of blank sidebar. After a quick inspect of webpage in chrome I found that when page is hosted, _sidebar.md was facing a fall back issue since it was loaded from each level directory.

The fix that worked for me was to use Nested Sidebar. I just added alias with the intex.html and my issue got fixed.

<script> window.$docsify = { loadSidebar: true, alias: { '/.*/_sidebar.md': '/_sidebar.md' } } </script>

Please try and see if this works

[jellehak]

Just found out that gh-pages is not serving the _sidebar.md files. It seems that it is ignoring files that start with an _ ( caused by Jekyll ). Solution is to add a .nojekyll file at the root.

More on this https://medium.com/@juliakmdev/learning-that-github-pages-struggles-with-certain-file-names-4d867d499ca9

[dmgrok]

@jellehak thanks for sharing, yes that solves the issue 👍

[ThomasThelen]

Can calso onfirm that adding .nojekyllto the project root solves this problem