README.md

🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
The content of this repo was moved to cosmwasm (CosmWasm/cosmwasm#2028)
🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨

CosmWasm IDL docs

Here's the live version.

Built using MkDocs.

Development

The gh-pages branch is for the release artifacts. Don't modify it directly. Any modifications will get overwritten during next deployment.

The MkDocs project maintains a quality User Guide.

Prerequisites

pip install mkdocs mkdocs-bootswatch

Iterating

mkdocs serve

This should get you a locally deployed website. If you open it in your browser, it will auto-update as you make changes to the .md docs.

Deploying

mkdocs gh-deploy

As long as you have write permissions to this repo, this should handle everything! It will update the gh-pages branch with the newly generated static website. GitHub will then pick it up and serve.