8000 deprecate the book.text-direction field from the configuration · Issue #2661 · rust-lang/mdBook · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

deprecate the book.text-direction field from the configuration #2661

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

Open
szabgab opened this issue Apr 11, 2025 · 0 comments
8B6A
Open

deprecate the book.text-direction field from the configuration #2661

szabgab opened this issue Apr 11, 2025 · 0 comments
Labels
C-enhancement Category: Enhancement or feature request

Comments

@szabgab
Copy link
Contributor
szabgab commented Apr 11, 2025

Problem

It is a bit confusing to have the text-direction field as it is not needed if the language field is set to one of the RTL languages.

It seems that the text-direction is now derived from the language field of the book section of the configuration.

According to the list of public mdbooks there is only one book using the separate text-direction field. I asked them to verify that the language-field is enough for them. persian-rust/book#6

Of course there are probably many other RTL books out there, some public some private.

Proposed Solution

I'd suggest to add a warning to mdbook if it encounters the use of the text-direction field. In the report mention that the language field should be enough and ask them to report here if for some reason they need the text-direction field.

Then, if there is no objection, a few months later remove this field from mdbook.

Notes

Current version mdbook v0.4.48

@szabgab szabgab added the C-enhancement Category: Enhancement or feature request label Apr 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Enhancement or feature request
Projects
None yet
Development

No branches or pull requests

1 participant
0