Skip to content

Latest commit

 

History

History
executable file
·
65 lines (43 loc) · 977 Bytes

File metadata and controls

executable file
·
65 lines (43 loc) · 977 Bytes

BerryAudio Documentation

Documentation for BerryAudio, built with VitePress.

Installation

Install the dependencies:

npm install

Bruno Collection

The Bruno API collection is located in:

bruno/

The collection is used to generate the API documentation.

Development

Generate the API documentation:

npm run docs:bruno

Start the documentation site:

npm run docs:dev

The documentation will be available at:

http://localhost:5173

Build

Build the documentation for production:

npm run docs:build

Preview the production build:

npm run docs:preview

Commands

Command Description
npm install Install dependencies
npm run docs:dev Start the documentation site
npm run docs:bruno Generate API documentation from bruno/
npm run docs:build Build the documentation
npm run docs:preview Preview the production build