Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.12 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.12 KB

WAX Developer Portal

Documentation Maintenance Twitter: WAXOIG

WAX Developer Portal - Inside the WAX Developer Portal, you'll find a wealth of resources to guide you on your development journey.

Installation

Prerequisites

  • Node.js version 18 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!