|
| 1 | +# 🌟 Injective Docs |
| 2 | + |
| 3 | +[The main documentation for Injective](https://docs.injective.network) |
| 4 | + |
1 | 5 | ---
|
2 |
| -description: >- |
3 |
| - Welcome to the official documentation for Injective, learn the basics of what |
4 |
| - Injective is, understand how it works and start building the most powerful |
5 |
| - financial dApp |
6 |
| ---- |
7 | 6 |
|
8 |
| -# Injective Docs |
| 7 | +## 📚 Getting Started |
| 8 | + |
| 9 | +1. Clone the repository and install dependencies |
| 10 | + |
| 11 | +```bash |
| 12 | +$ git clone [email protected]:InjectiveLabs/injective-docs.git |
| 13 | +$ cd injective-docs |
| 14 | +$ yarn |
| 15 | +``` |
| 16 | + |
| 17 | +2. Regenerate documentation based on the desired branches for `injective-core` and `cosmos-sdk` |
| 18 | + _Note: you can change the branches/tags in the `scripts/setup.sh` file_ |
| 19 | + |
| 20 | +```bash |
| 21 | +$ yarn generate |
| 22 | +``` |
| 23 | + |
| 24 | +You can now either run the documentation locally OR build it for deployment and deploy it to the desired hosting service. |
| 25 | + |
| 26 | +## 📚 Local Development |
| 27 | + |
| 28 | +``` |
| 29 | +$ yarn start |
| 30 | +``` |
9 | 31 |
|
10 |
| -## Getting Stared |
| 32 | +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
11 | 33 |
|
12 |
| -Read all about Injective Chain or dive straight into the code with guides |
| 34 | +## 📚 Build |
13 | 35 |
|
14 |
| -<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Dev Tools</strong></td><td></td><td>Set up your tools and build on Injective</td><td><a href=".gitbook/assets/8385819_currency_digital_offering_coin_initial_ico (1).svg">8385819_currency_digital_offering_coin_initial_ico (1).svg</a></td></tr><tr><td>Dev Guides</td><td></td><td>Learn by doing, CosmWasm and Exchange guides</td><td><a href=".gitbook/assets/8385840_coin_crypto_growth_interest_invest_income_passive.svg">8385840_coin_crypto_growth_interest_invest_income_passive.svg</a></td></tr><tr><td>Injective Native Modules</td><td></td><td>Injective is an open, interoperable layer-one blockchain</td><td><a href=".gitbook/assets/8385828_connection_cube_structure_network_technology_blockchain.svg">8385828_connection_cube_structure_network_technology_blockchain.svg</a></td></tr></tbody></table> |
| 36 | +``` |
| 37 | +$ yarn build |
| 38 | +``` |
| 39 | + |
| 40 | +This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 41 | + |
| 42 | +## 📚 Deployment |
| 43 | + |
| 44 | +Using SSH: |
| 45 | + |
| 46 | +``` |
| 47 | +$ USE_SSH=true yarn deploy |
| 48 | +``` |
| 49 | + |
| 50 | +Not using SSH: |
| 51 | + |
| 52 | +``` |
| 53 | +$ GIT_USER=<Your GitHub username> yarn deploy |
| 54 | +``` |
| 55 | + |
| 56 | +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. |
| 57 | + |
| 58 | +--- |
15 | 59 |
|
16 |
| -## Explore Injective Chain |
| 60 | +## 🔓 License |
17 | 61 |
|
18 |
| -Get familiar with Injective Chain and explore its main concepts. |
| 62 | +Copyright © 2021 - 2024 Injective Foundation (https://injective.com/) |
19 | 63 |
|
20 |
| -<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>What is Injective?</td><td></td><td>Injective is an open, interoperable layer-one blockchain for building powerful DeFi applications</td><td></td></tr><tr><td>Injective Hub</td><td></td><td>The platform and gateway that allows you to interact directly with Injective</td><td><a href=".gitbook/assets/8385836_money_send_transfer_crypto_bank_withdraw (1).svg">8385836_money_send_transfer_crypto_bank_withdraw (1).svg</a></td></tr><tr><td>Injective Basic Concepts</td><td></td><td>Cover all the Injective main concepts including the INJ Coin, Gas, Fees, Wallets and more</td><td><a href=".gitbook/assets/8385833_chip_token_money_budget_cryptocurrency_digital_coins.svg">8385833_chip_token_money_budget_cryptocurrency_digital_coins.svg</a></td></tr></tbody></table> |
| 64 | +<a href="https://iili.io/mNneZN.md.png"><img src="https://iili.io/mNneZN.md.png" style="width: 300px; max-width: 100%; height: auto" /> |
21 | 65 |
|
22 |
| -## Help & Support |
| 66 | +Originally released by Injective Foundation under: <br /> |
| 67 | +Apache License <br /> |
| 68 | +Version 2.0, January 2004 <br /> |
| 69 | +http://www.apache.org/licenses/ |
23 | 70 |
|
24 |
| -} /> } /> } /> |
| 71 | +<p> </p> |
| 72 | +<div align="center"> |
| 73 | + <sub><em>Powering the future of decentralized finance.</em></sub> |
| 74 | +</div> |
0 commit comments