/vkpr-docs

VKPR documentation (docussaurus project)

Primary LanguageJavaScript

VKPR Docs

Welcome to VKPR documentation project.

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run start

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

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Remote Development

You can use Okteto to setup a remote development container:

okteto up

This will create a node development container in okteto cloud synced to your project. Follow the on-screen instructions to start development mode.