docs.reearth.io

Re:Earth documentation website

This website is built using Docusaurus 2, a modern static website generator, and is hosted on Netlify.

Getting Started

For details, refer to Docusaurus website.

Installation

$ yarn

Local Development

$ yarn start

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

Translation

start to wirte Ja translation for example

$ yarn run start -- --locale ja

Write translations

yarn write-translations -- --locale ja

Build

$ yarn build

Build translation for Signle-domain

$ yarn run build

Test your build locally

$ npm run serve

Contribution

Feel easy to contribute to this project. Also see code of conduct.

• You can send a pull request directly:
  • Fixing typo
  • Fixing bugs and styles
  • Translating articles
• Suggest your idea by creating an issue before sending a pull request:
  • Writing new articles
  • Change the structure of articles
  • Modify the appearance
  • ...etc

License

• Source codes are MIT license licensed.
• Documentation (files in the /developer-guide, /docs, /tutorial and /user-manual folder) are CC-BY-SA 4.0 licensed.