|
1 |
| -**Translating the Masari website** |
| 1 | +# Translating the Masari Project website |
2 | 2 |
|
3 | 3 | English is the primary language across multiple projects worldwide. All translations should be based upon their English version.
|
4 | 4 |
|
5 |
| -***First Step*** |
| 5 | +## First Step |
| 6 | + |
6 | 7 | The first file you should focus on translating will be located here:
|
7 | 8 | - _i18n/en.yml
|
8 | 9 |
|
9 | 10 | Copy this file and rename it to your desired language code. Example: fr.yml would be great for French translation. In this file, be sure to add your language code and full language name under `Language:`.
|
10 | 11 |
|
11 |
| -*** Second Step *** |
| 12 | +## Second Step |
| 13 | + |
12 | 14 | The next step is to add your language to the site configuration file. This is located in the main directory and is titled `_config.yml`. Find the area in `_config.yml` that contains `languages:`. Add your language. Example: `languages: ["en", "fr"]`. Each language will be wrapped in quotes and will be seperated by commas.
|
13 | 15 |
|
14 |
| -*** Third Step *** |
| 16 | +## Third Step |
| 17 | + |
15 | 18 | The Masari website was designed and developed to have sections that can easily be edited, updated, removed and translated in an organized manner. This allows us to have a more flexible content website.
|
16 | 19 |
|
17 | 20 | The following files should also be translated. These files contain content for the RESEARCH CORNER, RESOURCES and ROADMAP sections. The content in DOWNLOADS should be fine as is. In the RESOURCES file, only the name field will need to be translated.
|
@@ -41,9 +44,13 @@ The following files should also be translated. These files contain content for t
|
41 | 44 |
|
42 | 45 | After translating the above files, the majority of the front page content should be translated.
|
43 | 46 |
|
44 |
| -*** Fourth Step *** |
| 47 | +## Fourth Step |
45 | 48 | Now that all the content has been translated, we will need to add your language to the website navigation. This will require opening `_includes/header.html`. Near the bottom of this file, you will find a line such as `<a href="/">{% t language.en %}</a>`. Change this line around a bit to match your language. Using our French example, we would add the following: `<a href="/fr">{% t language.fr %}</a>`. If other languages are listed, add your new language at the end of the listed languages.
|
46 | 49 |
|
47 |
| -*** Additional information *** |
| 50 | +### Additional information |
48 | 51 |
|
49 | 52 | The Masari guides are pulled from an external repository at this current time. Accessing our site at /guides will result in English only content (but will have everything else translated). You may submit a pull request on the (https://github.com/masari-project/masari-marketing)[masari-marketing] repository for your desired language.
|
| 53 | + |
| 54 | +### Questions? |
| 55 | + |
| 56 | +Should you have questions, we encourage you to open an [issue](https://github.com/masari-project/masari-project.github.io/issues/new). For more immediate assistance, visit us on [Discord](https://discord.gg/sMCwMqs) and make your statement in the #development channel. |
0 commit comments