diff --git a/docusaurus/docs/help-translate/help-translate.md b/docusaurus/docs/help-translate/help-translate.md new file mode 100644 index 000000000..221a01a00 --- /dev/null +++ b/docusaurus/docs/help-translate/help-translate.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 99 +--- + +# Help translate the docs + +I'm always looking for people to translate the documentation into different languages. +If you want to help use this guide to help you get started! + +## How to translate + +## Prerequisites + +* `nodejs` installed +* `npm` installed +* `git` installed + +## Setup i18n + + +* Fork the [https://github.com/thijsvanloef/palworld-server-docker](https://github.com/thijsvanloef/palworld-server-docker) repository +* Clone your created fork. +* Navigate to the `docusaurus` folder. +* Add your locale to the i18n config on line in the [docusaurus.config.js](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docusaurus/docusaurus.config.js) +* Run: `npm run write-translations -- --locale ` + +:::info +After running `npm run write-translations -- --locale ` a new folder will be created in the `i18n` folder +::: + +* Remove the `docusaurus-plugin-content-blog` folder +* Create a `current` folder inside `docusaurus-plugin-content-docs` +* Copy the contents of `docs` to the `current` folder +* Start translating! + +## Testing the translation + +If you are done translating you can test that version of the site by doing the following: + +* Navigate to the `docusaurus` folder +* Run: `npm start -- --locale ` + +## Opening a Pull request + +* Go to [https://github.com/thijsvanloef/palworld-server-docker/compare](https://github.com/thijsvanloef/palworld-server-docker/compare) +* Select your repository/branch +* Press: `Create pull request`