docsifyjs / docsifyjs/docsify

Sidebar and navbar path configs need to take into account the routerMode

Open
#2,133 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

Description

PR https://github.com/docsifyjs/docsify/pull/1970 adds more documentation on how routerMode currently affects sidebar and navbar loading.

Ideally, there should not be any difference, and the sidebar and navbars paths should be determined in the same way no matter the routerMode.

With hash router mode, it seems that the paths are determined from the base of the site, whereas with history router mode, the paths are determined based on the current page path.

Contributor guide

Open the contributing guide

Research direction

Read PR https://github.com/docsifyjs/docsify/pull/1970 first, then reproduce sidebar and navbar loading in both hash and history router modes. Trace how each mode resolves those paths; done means the sidebar and navbar paths are determined consistently regardless of routerMode.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.