Guide: Introduce translation to the german language #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rzerres
force-pushed
the
wip_german
branch
4 times, most recently
from
55b1e66 to
f576ddb
Compare
Referencing rust-lang#5 (comment).
The book paths have to gracefully degrade to the default language if they aren't available.
- Add a [language] table to book.toml. Each key in the table defines a new language with `name` and `default` properties. - Changes the directory structure of localized books. If the [language] table exists, mdBook will now assume the src/ directory contains subdirectories named after the keys in [language]. The behavior is backwards-compatible if you don't specify [language]. - Specify which language of book to build using the -l/--language argument to `mdbook build` and similar, or omit to use the default language. - Specify the default language by setting the `default` property to `true` in an entry in [language]. Exactly one language must have `default` set to `true` if the [language] table is defined. - Each language has its own SUMMARY.md. It can include links to files not in other translations. If a link in SUMMARY.md refers to a nonexistent file that is specified in the default language, the renderer will gracefully degrade the link to the default language's page. If it still doesn't exist, the config's `create_missing` option will be respected instead.
Changes how the `book` module loads books. Now it is possible to load all of the translations of a book and put them into a single output folder. If a book is generated this way, a menu will be created in the handlebars renderer for switching between languages.
We can't redirect in warp based on the URL, so redirect to the default language's 404 page instead. See: seanmonstar/warp#171
It will follow relative links to other pages and embedded images.
…cher-js Only switch to themes on buttons that have the `theme` class
Signed-off-by: Ralf Zerres <[email protected]>
* new README * new SUMMARY Signed-off-by: Ralf Zerres <[email protected]>
Update pulldown-cmark version
Update semver dev-dependency in nop-preprocessor example to 1.0
Make page-break configurable
style: add missing word
# Conflicts: # .gitignore # guide/src/en/cli/completions.md # guide/src/en/format/images/rust-logo-blk.svg # guide/src/en/format/markdown.md # guide/src/en/misc/introduction.md # src/renderer/html_handlebars/hbs_renderer.rs # src/utils/mod.rs
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
rzerres
force-pushed
the
wip_german
branch
2 times, most recently
from
43072f5 to
a73a618
Compare
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
* python preprocessor snippet Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
|
rebased and updated with new subsections documentation |
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
Signed-off-by: Ralf Zerres <[email protected]>
* move md files to guide/src/en/guide/ Signed-off-by: Ralf Zerres <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dear Ruin0x11,
i do maintain the documentation for the public OrbTk framework, The Rust UI Toolkit . As a Rust project it was quite nice to get hold of mdBook, that we did adopt very early and started work on a hight-level documentation. I am following the development of mdBook since then.
Lately i did realize, that you have created a PR to support language support just the way i wanted to handle the supported variants in sudirectories that can consume the leading english variant. At best, i can share listings for examples and images while using symbolic links inside the language variants, pointing to the documentation root. This is the clean approach i was lokking for. Thank you and all the committers for this work.
This weekend i took the time to translate the book-example to the german language. This was a great opportunity to get into the glitches, learning new features. With this knowledge on hand it will for sure improve our book.
Since upstream moved on, i tried to rebase on master (commit 93008cf). But this turned out to be nontrivial ...
I didn't succed to merge in your branch localization-3 to get a working mdbook branch wip_localization with your proposed changes. So I deleted it and just based on master. This is availabel in a clean branch
wip_german.I will update my translations in this branch. Commit descriptions should be obvious for a cherry-pick.
Just let me know, if i can help in a meaningful way. All the best
Ralf