docsifyjs/docsify

option to put sidebar on the right

Open

#1,282 opened on Jul 13, 2020

View on GitHub
 (14 comments) (4 reactions) (0 assignees)JavaScript (26,454 stars) (5,630 forks)batch import
enhancementgood first Issuepr welcomeready to implementsemver-minor

Description

Feature request

An option to put the sidebar on the right instead of the left

What problem does this feature solve?

Sometimes people want it on the other side (maybe they embed Docsify somewhere that already has a sidebar on the left, or maybe they have a custom landing page with a custom menu on the right and when they click the link to go to documentation they'd also want the docs to have the sidebar on the same side).

What does the proposed API look like?

rightSidebar: true // or false

or

sidebarPosition: 'right' // or 'left'

How should this be implemented in your opinion?

I think we might be able to achieve this just with CSS, leaving the markup alone.

cc @jhildenbiddle for CSS expertise here.

Are you willing to work on this yourself?

Of course (if/when I get the time)!

Contributor guide

Tech stack
javascripthtmlcss
Domain
frontendaccessibility
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic CSS knowledgefamiliarity with Docsify config
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding a configuration option to move the sidebar to the right side of the page. The proposed API includes either a 'rightSidebar: true' or 'sidebarPosition: 'right'' option. The implementation is expected to be CSS only, as suggested in the issue. To begin, review the Docsify source code, particularly the CSS files that control sidebar positioning (e.g., src/themes/base/css or similar). Look for existing sidebar layout rules and consider how to conditionally apply a 'right' side via a configuration flag. The discussion in the issue may provide additional insights; check comments from maintainers or contributors for suggested approaches. No linked pull requests or assignees indicate the issue is open for contribution.