Welcome to RSVIM Documentation!

To setup local environment, please install below dependencies:

1. node.js with 18.0+ version
2. docusaurus

To start local service, please run below commands:

1. npm install
2. npm run start

To build production docs, please run below commands:

1. npm run build
2. npm run serve

To format docs, please install below formatters:

• prettier

To sync API docs from rsvim, please follow below steps:

1. Clone the rsvim repo and place it with this repo under the same directory.
2. Run npm install -g typedoc to install typedoc command.
3. Run npm install to install all dependencies.
4. Run ./gendoc.sh scripts to sync all API docs.

To configure the Search index, please go to Doc Search.

To tag a version, please run below commands (see Docusaurus - Versioning):

1. npm run docusaurus docs:version 0.1.0