@vime/docs

Vime is a customizable, extensible, accessible and framework agnostic media player. This package contains the source code for the Vime documentation site hosted at https://vimejs.com. The website is built using Docusaurus 2, a modern static website generator.

Local Development

$: npm install

$: npm run dev

The start command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

API Documentation

It's important to note that components is autogenerated by @vime/core. If you'd like to update those then run the following to update:

$: npm run build:api