README.md

docs

We warmly welcome your contribution!

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
• Installed NodeJs, 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

npm i
npm run docs:dev

• IF do you like yarn (optional)

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

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