Skip to content

wax-office-of-inspector-general/wax-developer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WAX Developer Portal

Documentation Maintenance Twitter: WAXOIG

WAX Blockchain Documentation - Resources for developers building on WAX

Installation

Prerequisites

  • Node.js version 20 or higher.
  • Terminal for accessing VitePress via its command line interface (CLI).
  • Text Editor with Markdown syntax support.
  • VSCode is recommended, along with the official Vue extension.

VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with:

npm install

Up and Running

The tool should have also injected the following npm scripts to your package.json if you allowed it to do so during the setup process:

{
  ...
  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs",
    "docs:preview": "vitepress preview docs"
  },
  ...
}
npm run docs:dev

What's Next?

Read the vitepress docs

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Star this project to receive updates and show your support!