Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for right-to-left languages #1165

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Conversation

mgeisler
Copy link
Collaborator

@mgeisler mgeisler commented Sep 4, 2023

This updates our mdbook version to the latest version in Git. I copied the index.hbs file from that version and back-ported our changes into it. I checked English and Danish locally and they both look fine.

The new version has support for right-to-left languages: rust-lang/mdBook#1641.

We have an in-progress Persian translation. Download the fa.zip artifact after building the PR to check how it looks. I checked Persian locally and it looks mirrored like I expect (but we will need someone who can read Persian to actually verify this).

Fixes #1164.

This updates our `mdbook` version to the latest version in Git. I
copied the `index.hbs` file from that version and back-ported our
changes into it. I checked English and Danish locally and they both
look fine.

The new version has support for right-to-left languages:
rust-lang/mdBook#1641.

We have an in-progress Persian translation. Download the `fa.zip`
artifact after building the PR to check how it looks. I checked
Persian locally and it looks mirrored like I expect (but we will need
someone who can read Persian to actually verify this).

Fixes #1164.
@mgeisler
Copy link
Collaborator Author

mgeisler commented Sep 4, 2023

The tests are done. @mbpouri and @DannyRavi, can you please take a look at comprehensive-rust-fa.zip and let us know how it looks?

Copy link
Collaborator

@DannyRavi DannyRavi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the implementation I had from comprehensive-rust-fa.zip, the RTL result is good, and according to the experience of RTLs on other platforms, when each line of text starts with an LTR letter, an error occurs in the text.
Also, please check rust-lang/mdBook#1164

@mgeisler
Copy link
Collaborator Author

mgeisler commented Sep 5, 2023

According to the implementation I had from comprehensive-rust-fa.zip, the RTL result is good, and according to the experience of RTLs on other platforms, when each line of text starts with an LTR letter, an error occurs in the text. Also, please check rust-lang/mdBook#1164

Thanks @DannyRavi! I think we should merge this then and we'll let you and others figure out any small details in the coming weeks.

@mgeisler
Copy link
Collaborator Author

mgeisler commented Sep 5, 2023

@DannyRavi, I've invited you to collaborate on the repository — this should let you add a review on this PR so I can merge it!

@mgeisler mgeisler merged commit 09d1265 into main Sep 7, 2023
33 checks passed
@mgeisler mgeisler deleted the support-right-to-left branch September 7, 2023 07:50
@mgeisler
Copy link
Collaborator Author

mgeisler commented Sep 8, 2023

This is now published, see: https://google.github.io/comprehensive-rust/fa/ 🚀

yohcop pushed a commit to yohcop/comprehensive-rust that referenced this pull request Sep 12, 2023
This updates our `mdbook` version to the latest version in Git. I copied
the `index.hbs` file from that version and back-ported our changes into
it. I checked English and Danish locally and they both look fine.

The new version has support for right-to-left languages:
rust-lang/mdBook#1641.

We have an in-progress Persian translation. Download the `fa.zip`
artifact after building the PR to check how it looks. I checked Persian
locally and it looks mirrored like I expect (but we will need someone
who can read Persian to actually verify this).

Fixes google#1164.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Test new mdbook right-to-left rendering
3 participants