/VORP_Documentation

How to use vorp built in API in your scripts

GNU General Public License v3.0GPL-3.0

VORP_Documentation

This is the repo for VORPCore Framework documentation and website!

How to setup

  1. Clone this repo
  2. Install Node/NPM Guide
  3. Open your terminal
  4. Navigate to the project director. Eg. CD vorp-api-docs
  5. Run npm install
  6. Run npm run docs:dev
  7. You should now be able to see a local version of the site running on http://localhost:5173/vorp-api-docs/

File Structure

docs -> vitepress (App settings)

docs -> api (API Doc folder) -> API Doc Pages.md

docs -> public (Public images)

docs -> api.md (root api page)

docs -> guide.md (setup guide)

docs -> index.md (Home page)

docs -> team.md (Team page)