feat: Add Right-to-Left (RTL) layout support #2551
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new feature enabling Right-to-Left (RTL) layout for docsify sites.
Key changes:
- **Configuration:** Added a new boolean option `rtl` (default: `false`) to `window.$docsify` configuration in `src/core/config.js`. Setting this to `true` enables RTL mode.
- **Styling:**
- Created `src/themes/shared/_rtl.css` with specific styles for RTL layout, including adjustments for text direction, sidebar positioning, and content margins.
- Imported `_rtl.css` into `src/themes/shared/__index.css`.
- **Behavior:** Modified `src/core/Docsify.js` to add a `rtl` class to the `<body>` element when `config.rtl` is true. This class activates the RTL-specific CSS rules.
- **Testing:** Added a new end-to-end test suite in `test/e2e/rtl.test.js` to verify:
- The `rtl` class is applied to the body.
- The sidebar is positioned on the right.
- Content margins are adjusted for the right-hand sidebar.
- **Documentation:** Updated `docs/configuration.md` to document the new `rtl` option, its type, default value, and usage.
This feature addresses your request for better RTL support, allowing you to create documentation sites that cater to RTL languages.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Thanks for your contribution. I added some screenshots. There are some issues, such as search shortcut key prompts, etc. Check screenshots
|
rrickay
reviewed
Jun 10, 2025
| this.initFetch(); // Fetch data | ||
|
|
||
| if (this.config.rtl) { | ||
| document.body.classList.add('rtl'); |
There was a problem hiding this comment.
Instead of adding a class, what about using the dir attribute?
<html dir="rtl"> and target the changes in the layout using that as the selector? [dir=rtl] .layout
There was a problem hiding this comment.
Agree with @rrickay that using dir="rtl" is more reasonable since it is the standard HTML attr for RTL contents layout.
But if it add-on on html level for all contents, there is no place to change non-RTL content(img, code...etc) to place as LTR.
Maybe the styling on RTL should be more specific either configurable.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This commit introduces a new feature enabling Right-to-Left (RTL) layout for docsify sites.
Related issue, if any:
Close #2511
What kind of change does this PR introduce?
rtl(default:false) towindow.$docsifyconfiguration insrc/core/config.js. Setting this totrueenables RTL mode.src/themes/shared/_rtl.csswith specific styles for RTL layout, including adjustments for text direction, sidebar positioning, and content margins._rtl.cssintosrc/themes/shared/__index.css.src/core/Docsify.jsto add artlclass to the<body>element whenconfig.rtlis true. This class activates the RTL-specific CSS rules.test/e2e/rtl.test.jsto verify:rtlclass is applied to the body.docs/configuration.mdto document the newrtloption, its type, default value, and usage.For any code change,
Does this PR introduce a breaking change?
No
Tested in the following browsers: