docsifyjs/docsify

option to put sidebar on the right

Open

#1,282 opened on 2020年7月13日

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

説明

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)!

コントリビューターガイド

技術スタック
javascripthtmlcss
領域
frontendaccessibility
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic CSS knowledgefamiliarity with Docsify config
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
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.