# docs
We warmly welcome your contribution!
---
![image](https://user-images.githubusercontent.com/5887929/217538785-3d974de5-0436-441e-8181-abe176d65790.png)


We need to document our KodaDot engine running at https://kodadot.xyz with repository at https://github.com/kodadot/nft-gallery/
It's accessible at https://docs.kodadot.xyz


### Requirements
- Having GIT client, we recommend using [Github Desktop](https://desktop.github.com/)
- Installed [NodeJs](https://nodejs.org/en/), we reccomend to use LTS version

### To run it locally

- clone git repository locally
  - Easy - best through Github Desktop, clone `git@github.com:kodadot/docs.git`
  - Hard - in command line, run `git clone git@github.com:kodadot/docs.git` 

- open directory `docs/` in your command line 
- in same command line run commands bellow

```bash
npm i
npm run docs:dev
```
- IF do you like yarn (optional)
```bash
yarn
yarn docs:dev
```

- Then navigate in your browser to the https://localhost:8080 
- You'll see preview of your current **docs** running

### How to Edit
- Anytime you edit **\*.md** file, hit save and you should see new rendered version in your browser

#### Deployment
```bash
yarn docs:build
```

# How to add and modify?

Learn at https://v2.vuepress.vuejs.org/guide/markdown.html



### Migration KodaDot knowledge base from other sources
Our old resources to be migrated here

- https://kodadot.gitbook.io/
- https://github.com/kodadot/nft-gallery/wiki