Giter Club home page Giter Club logo

docs's Introduction

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 https://cosmwasm-docs.vercel.app.

How is it made?

The deployed documentation is a Nextra 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:

npm install
npm run build
npm run start

You will now be able visit the locally served website at http://localhost:3000

How can I contribute?

After cloning this repo, make sure you use node v20 before running these commands:

npm install
npm run dev

The website will be available at 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 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.

docs's People

Contributors

aumetra avatar abefernan avatar chipshort avatar uint avatar jawoznia avatar dariuszdepta avatar webmaster128 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.