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

Test new mdbook right-to-left rendering #1164

Closed
mgeisler opened this issue Sep 4, 2023 · 3 comments · Fixed by #1165
Closed

Test new mdbook right-to-left rendering #1164

mgeisler opened this issue Sep 4, 2023 · 3 comments · Fixed by #1165
Assignees

Comments

@mgeisler
Copy link
Collaborator

mgeisler commented Sep 4, 2023

With rust-lang/mdBook#1641 merged, we can now test out the right-to-left rendering.

We should

  1. Update mdbook to use a version from Git (edit .github/workflows/install-mdbook/action.yml).
  2. Enable publication for Persian translation #671.
  3. Ensure that Persian is rendered nicely (ask @mbpouri and @DannyRavi for input).
@mgeisler mgeisler self-assigned this Sep 4, 2023
mgeisler added a commit that referenced this issue 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.
mgeisler added a commit that referenced this issue 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.
@DannyRavi
Copy link
Collaborator

It seems that there is a problem with Hyperlinks markdown in RTL mode.

Screenshot from 2023-09-05 12-31-48
and
Screenshot from 2023-09-05 12-21-21

Also, few translations into Farsi have been done and I will try to finish the continuation of translations into Farsi soon.

@mgeisler
Copy link
Collaborator Author

mgeisler commented Sep 5, 2023

Hi @DannyRavi, thanks for testing it!

I looked into this case and the problem is actually that the link is escaped in the fa.po file. That should be fixed with a normal edit.

I tried editing fa.po a bit locally and I was able to get links working, both with English and Persian text.

Did you see any big problems in the layout or is this looking correct? To me, it looks nicely mirrored, but I'm not sure what I should look for 🙂

@DannyRavi
Copy link
Collaborator

Hi @mgeisler. thanks for solving it!
Now I see no issues with RTL and rendering and everything looks great.

mgeisler added a commit that referenced this issue Sep 7, 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.
yohcop pushed a commit to yohcop/comprehensive-rust that referenced this issue 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 a pull request may close this issue.

2 participants