Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CosmWasm/docs
https://github.com/CosmWasm/docs
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/CosmWasm/docs
- Owner: CosmWasm
- License: apache-2.0
- Created: 2024-04-15T11:13:13.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-22T11:42:37.000Z (8 months ago)
- Last Synced: 2024-04-22T12:49:16.233Z (8 months ago)
- Language: JavaScript
- Homepage: https://cosmwasm-docs.vercel.app
- Size: 1.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - CosmWasm/docs - (MDX)
README
# The CosmWasm documentation platform
## What is it?
A documentation-focused website for all CosmWasm-related technologies.
No matter if you need to integrate CosmWasm with a chain, create some smart
contracts, or just have a look around to see what CosmWasm is about, here you'll
be able to learn about CosmWasm's core, wasmd, storage, testing, IBC,
CosmJS/InterchainJS, Sylvia framework, etc.
## Where is it?
The website is hosted at
[docs.cosmwasm.com](https://docs.cosmwasm.com/).
## How is it made?
The deployed documentation is a [Nextra](https://nextra.site) project configured
with the `nextra-theme-docs` package.
## How can I run it locally?
You can just clone this repo and run the following commands, after making sure
you use node `v20`:
```shell
npm install
npm run build
npm run start
```
You will now be able visit the locally served website at
[http://localhost:3000](http://localhost:3000)
## How can I contribute?
After cloning this repo, make sure you use node `v20` before running these
commands:
```shell
npm install
npm run dev
```
The website will be available at [http://localhost:3000](http://localhost:3000)
and the changes you make to the project will be reflected there instantaneously.
There's a hidden "How to doc" section that'll teach you how to write new
entries. You can make this section visible by visiting
[http://localhost:3000/how-to-doc](http://localhost:3000/how-to-doc) or with the
CTRL + . (control plus period) keyboard shortcut.
After committing your changes to a new branch, push it to this repo and open a
PR. This will automatically generate a Vercel preview link for the reviewers to
check.