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

Localising the website #104

Closed
karthanistyr opened this issue Jan 5, 2022 · 5 comments
Closed

Localising the website #104

karthanistyr opened this issue Jan 5, 2022 · 5 comments

Comments

@karthanistyr
Copy link
Contributor

It's recently been made obvious to me that although the mod itself is fully localised, the documentation (website) was not.
Any opinions on how to do that ?

@karthanistyr
Copy link
Contributor Author

karthanistyr commented Jan 5, 2022

The simplest approach would be to duplicate index.html into index.lang.html and translating there, adding links to the various locales at the top (deaulting to english). Drawback is that the page structure is duplicated and any change would have to be mirrored manually.

More complete, more robust approach would propbably be something like https://letrastudio.github.io/jekyll-i18n/

@oddlama
Copy link
Owner

oddlama commented Jan 5, 2022

The website itself is available in the docs/ folder. The only relevant part for localization is the index.html - it's just a static and very simple website.

Ideally, I would split all translatable strings from the index.html into subfiles for each language and assemble them into separate files with a language selector whenever the page is rebuilt. Going forward, I'm tempted using gitbook in the future, where we could translate pages individually. But this would make the whole documentation less accessible and seemingly more complex with all the subpages.

@karthanistyr
Copy link
Contributor Author

Ideally, I would split all translatable strings from the index.html into subfiles for each language and assemble them into separate files with a language selector whenever the page is rebuilt.

Yes that would probably be a nice stop gap, shy of implementing a full i18n solution (which doesn't look straightforward with Jekyll and therefore a much higher bar to meet). Would be happy to provide the French version if you come around to doing that.

@ryantheleach
Copy link
Contributor

I'm not sure how to tie it in, but Sponge previously used readthedocs with https://crowdin.com/

@oddlama
Copy link
Owner

oddlama commented Aug 24, 2022

I currently don't have the time to do this properly. If I ever get to write a new translation system (#118) I will include this.

@oddlama oddlama closed this as completed Aug 24, 2022
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

No branches or pull requests

3 participants