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

mdbook docs with i18n support with github action to upload source file to Crowdin and download translation #119

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

krmanik
Copy link
Member

@krmanik krmanik commented Feb 2, 2024

I have used mdbook-i18n-helpers to add support for docs other than english language. Currently only crowdin target language .po file added in po directory.

  • Files removed to setup for mdBook documentation.
  • New theme was added using the command mdbook init --theme which included language picker, right-to-left (RTL) support, and keyboard navigation.
  • Essential configuration files such as book.toml, Cargo.toml, dprint.json, .nojekyll, and .gitignore were added.
  • Markdown formatting for AnkiDroid documentation is added (formatted using the dprint fmt tool), and the localization tool from AnkiDroid added to upload source messages.pot and download translated messages-*.po files.
  • The initial languages (arabic, japanese, russian, chinese) were included, along with tools for automatic updates.
  • If new translation added on crowdin Sync Translation action will download and update the translation.

Translation completed using Machine Translation of Crowdin.

Result
Documentation url with i18n support

Pull request created using Sync translation
https://github.com/krmanik/ankidroiddocs/pulls

Actions result
sync_translations
build
publish

@abdnh abdnh mentioned this pull request Feb 14, 2024
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.

1 participant