https://github.com/gear-foundation/gear-wiki
Gear documentation portal for developers. Contributions are welcome!
https://github.com/gear-foundation/gear-wiki
blockchain gear rust vara vara-network wasm web3
Last synced: 3 months ago
JSON representation
Gear documentation portal for developers. Contributions are welcome!
- Host: GitHub
- URL: https://github.com/gear-foundation/gear-wiki
- Owner: gear-foundation
- License: cc0-1.0
- Created: 2021-08-16T12:56:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T23:34:51.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:00:02.830Z (over 2 years ago)
- Topics: blockchain, gear, rust, vara, vara-network, wasm, web3
- Language: MDX
- Homepage: https://wiki.gear-tech.io
- Size: 60.4 MB
- Stars: 19
- Watchers: 9
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gear Wiki
[](https://github.com/gear-foundation/gear-wiki/actions/workflows/publish.yml?query=branch%3Amaster)
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](https://nodejs.org) and [Yarn](https://yarnpkg.com).
1. Make a local clone of Wiki repository:
```bash
git clone https://github.com/gear-foundation/gear-wiki.git
cd wiki
```
2. Install dependencies:
```bash
yarn install
```
alternatively
```bash
npm install
```
3. Start your local Wiki copy and instantly track changes you've made. Open it in your default browser - http://localhost:3000/:
```bash
yarn start
```
alternatively
```bash
npm run start
```
#### Tips
If you want to run with your locale, please use below commands
```bash
yarn start --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](https://github.com/gear-foundation/gear-wiki/issues/new) or create a [pull request](https://github.com/gear-foundation/gear-wiki/pulls).
## License
The content on the Gear Wiki website is distributed under the [CC0 1.0 Universal License](LICENSE).