ASEAN BTE Docs

ASEAN BTE Docs website consists all the important docs related to builder guide, plot system workflow, API etc..

Made with Docusaurus

Prerequisites

Before installation, please make sure you have already installed following tools:

• Git
• NodeJs

Installation Steps

1. Fork the project
2. Clone the project
3. Navigate to the project directory cd ASEAN-Docs
4. Install dependencies with npm install
5. Run npm start

How to translate/edit the docs ?

Go to docs page which you want to transalte/edit and click the edit button and do the following changes. Don't change the content inside ---

After editing the file, click the propose changes button and wait until the maintainers review it.

How to translate/edit the content of the website ?

If the language is been already configured in docusaurus.config.js, skip to step

If the text is wrapped under Translate tag, skip to step

1. Configure the language in docusaurus.config.js by adding the languages's aliases to this list.

2. Start the locale site by using the following commmand

   npm run start -- --locale <locale-aliases>

3. Import the Translate module of docusaurus

4. Wrap the text which is to be translated by using the Translate tag. Make sure that the text which is wrapped is simple, plain text without any tags in between them

5. Run the following command, to generate JSON files where you could add the translated version of the text

   npm run write-translations -- --locale <locale-aliases>

6. After translation, run npm build.

Contributors