ko-translate #20
ko-translate #20
Conversation
There was a problem hiding this comment.
Thanks for the intense work involved in translating all the pages!
There are some more minor changes needed, I've created a temporary branch to demonstrate what they are: https://github.com/cpp-gamedev/learn-vulkan/compare/CDDing:feature/translations..karnage/ko-fixes. Update "KR" to the actual text you want in the language dropdown.
I'd request you to add yourself as an author for KO as well (similar to ZH).
Please preview the website and make sure it appears and works as you expect: to do this, run
cd guide
cmake -P build.cmake
And then open guide/book/index.html in a browser.
|
I just fixed by you recommendded, but this error occured when i try to build it. I also pushed it. |
Weird, I just approved CI and it built the website fine there: https://github.com/cpp-gamedev/learn-vulkan/actions/runs/14779911533/job/41502215999?pr=20 |
* Preliminary multilingual support (#10) * Preliminary multilingual support mdBook does not natively support multilingual documentation. A common approach is to use a third-party library like mdbook-i18n-helper, which relies on a Gettext-based workflow to enable multilingual support. However, I believe such a complex system is unnecessary for our case. Therefore, this commit follows the approach suggested in the official mdBook documentation: overriding the 'index.hbs' template to add a button that redirects users to the corresponding documentation in another language, thus achieving basic multilingual support. This commit introduces the following three files under the theme directory: - 'index.hbs': Adds a redirect button for switching languages. - 'lang-toggle.css': Defines the styling for the button and the dropdown menu. - 'lang-toggle.js': Implements the main logic behind the button's behavior. As a result, two separate books need to be built. However, since mdBook’s 'book.toml' does not support multiple '[book]'' sections in a single configuration. This commit introduces a CMake script to build different language versions of the book and place them in their respective directories. It can be tested by command 'cmake -P build.cmake'. Due to mdBook's behavior, the 'src' field in 'book.toml' determines the root URL. Therefore, if the theme directory is placed above the src directory, mdBook will copy it relative to the 'src' path during the build, which will cause the theme folder to become unreachable. Since English is the primary language of this documentation, the default behavior supports running 'mdbook' command directly from the guide directory, such as with 'mdbook serve'. However, this will only generate the English version of the documentation, other languages will not be built. To build other language versions using the mdbook command directly, it must manually adjust their respective book.toml files. All translations are placed under 'guide/translations'. To add a new language, it need to follow the same folder structure, update the CMake script, and register the new language in 'theme/index.hbs'. [1]: https://github.com/google/mdbook-i18n-helpers * Stick to 'snake_case' for filenames * Stick to 'snake_case' for file reference * Add CI workflow to build guide books (#13) * Add build book job to CI * Test book build breakage * `execute_process()`: treat errors as fatal * Revert deliberate breakage * Replace Karn Kaul with Karnage (#14) * ko-translate (#20) * ko-translate getting_started * ko-translate initialization.md * ko-translate rendering * ko-translate ImGui * ko-translate shader_objects * ko-translate memory * ko-translate descriptorSets * revise and summary * fix --------- Co-authored-by: Karn Kaul <karnkaul@gmail.com> * Remove zh-TW --------- Co-authored-by: Mes <mes900903@gmail.com> Co-authored-by: MyungKun Chang <58208787+CDDing@users.noreply.github.com>
ko-translate