docsify feat: Add Right-to-Left (RTL) layout support

feat: Add Right-to-Left (RTL) layout support

Open ssuvamm opened this issue 6 months ago • 2 comments

This commit introduces a new feature enabling Right-to-Left (RTL) layout for docsify sites.

Close #2511

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.