jachengM / windmetaverse-doc

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Upload files for translation

yarn crowdin upload

Download latest translation files

yarn crowdin download

Run local site with different locale

yarn start --locale fr

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Translators

Be careful to know which strings should not be translated. You can find more information on Docusaurus' site about which should never be translated.