allow right to left styling of docs #34486
Conversation
* adding rtl css main file and logic to use
|
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @georgeclaghorn (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review. Please see the contribution instructions for more information. |
| @@ -116,6 +117,10 @@ def select_only(guides) | |||
|
|
|||
| def copy_assets | |||
| FileUtils.cp_r(Dir.glob("#{@guides_dir}/assets/*"), @output_dir) | |||
| if (@rtl) | |||
There was a problem hiding this comment.
Here you don't need parentheses.
| @@ -0,0 +1,762 @@ | |||
| /* Guides.rubyonrails.org */ | |||
| /* Main.css */ | |||
There was a problem hiding this comment.
Although it would be copied to main.css, it may be useful to maintain here that it is in fact Main.rtl.css.
| @@ -17,13 +17,14 @@ module RailsGuides | |||
| class Generator | |||
| GUIDES_RE = /\.(?:erb|md)\z/ | |||
|
|
|||
| def initialize(edge:, version:, all:, only:, kindle:, language:) | |||
| def initialize(edge:, version:, all:, only:, kindle:, language:, rtl: false) | |||
There was a problem hiding this comment.
Regarding variable naming, I would prefer to have right_to_left instead of rtl for better readability.
allow right to left styling of docs
|
@rafaelfranca regarding my naming suggestion, without the context of this PR I wouldn't know what RTL means, the first thing that comes to my mind when I read RTL is the german TV channel. Other parameters in the constructor are algo in this fashion (ex. |
|
@albertoalmagro I would suggest that we rename the parameter to What do you think @rafaelfranca? |
|
Agree with @paracycle. |
|
Sounds good, I'll create the pr on Sunday. I'll also add this info to the docs on translating the docs :) |
|
Thanks @tamarr but there is not need, at least for the On the other hand, I would like to give @paracycle credit as I think his suggestion is key 👍 |
|
thanks @albertoalmagro for the comments and the update and sorry for the delayed response, having crazy weeks at work 😅 and thanks @paracycle for the review and suggestions! |
Summary
Adding ability to specify rtl for guides that will generate right to left guides with appropriate styling.
Other Information
Guides will still generate left-to-right by default. A new environment variable will be checked 'RTL=true' which will generate the guides with right to left styling.
The new stylesheet
main.rtl.cssis copied frommain.csswith right and left swapped as well as some other updates to padding and margin. When the switch is passed -main.csswill be deleted andmain.rtl.csswith be renamed tomain.css. While changes to main.css will have to be also ported to main.rtl.css, manipulating the file itself from the generator did not seem right.The anchor comparison was updated to unescaped since html escapes the Hebrew chars and the comparison fails.
Here are some basic examples, not fully translated: