https://github.com/rsvim/rsvim.github.io

RSVIM Documents.
https://github.com/rsvim/rsvim.github.io

Last synced: 9 days ago
JSON representation

RSVIM Documents.

• Host: GitHub
• URL: https://github.com/rsvim/rsvim.github.io
• Owner: rsvim
• License: apache-2.0
• Created: 2024-05-21T05:16:32.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T05:09:04.000Z (about 2 months ago)
• Last Synced: 2024-09-18T07:47:43.710Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://rsvim.github.io/
• Size: 773 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE.txt

Awesome Lists containing this project

README

        
# Welcome to RSVIM Documentation!

To setup local environment, please install below dependencies:

1. [node.js](https://nodejs.org/) with 18.0+ version

2. [docusaurus](https://docusaurus.io/)

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`](https://prettier.io/)

To sync API docs from [rsvim](https://github.com/rsvim/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](https://docsearch.algolia.com/).

To tag a version, please run below commands (see [Docusaurus - Versioning](https://docusaurus.io/docs/versioning)):

1. `npm run docusaurus docs:version 0.1.0`