Gear Wiki

Welcome to Gear network documentation portal for developers. It provides guides and documentation for everyone who wants to start developing using the Gear ecosystem. While our project is developing and growing, it is a modern knowledge base at the moment. Contributions are welcome!

🕸️ https://wiki.gear-tech.io

Build Locally

0. Install Node.js and Yarn.

1. Make a local clone of Wiki repository:

   git clone https://github.com/gear-foundation/gear-wiki.git
   cd wiki

2. Install dependencies:

   yarn install

   alternatively

   npm install

3. Start your local Wiki copy and instantly track changes you've made. Open it in your default browser - http://localhost:3000/:

   yarn start

   alternatively

   npm run start

Tips

If you want to run with your locale, please use below commands

yarn start --locale <locale>

For example, if you want to run Chinese version, please run yarn start --locale zh-cn.

Contribute

If you have anything to write on the Wiki, feel free to open an issue or create a pull request.

License

The content on the Gear Wiki website is distributed under the CC0 1.0 Universal License.