OpenValve Documentation Page

doc.open-valve.com page: Everything you need to know about OpenValve.

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

OpenValve Documentation

This repository contains the documentation website for OpenValve.

It is built using Docusaurus.

The published documentation is available at:

https://docs.open-valve.com

Development

Install dependencies:

npm install

Start the local development server:

npm run start

By default, the local website is available at:

http://localhost:3000

Build

Create a production build:

npm run build

Preview the production build locally:

npm run serve

Locales

Start the development server for a specific locale:

npm run start -- --locale de

Build a specific locale:

npm run build -- --locale de

Replace de with the locale you want to test.

Deployment

The source files are kept on the main branch.

The generated website is deployed to the gh-pages branch and served through GitHub Pages.

Typical deployment workflow:

git add .
git commit -m "Update docs"
git push origin main
set GIT_USER=fabiansteiner&& npm run deploy

Custom domain

The custom domain is configured through:

static/CNAME

The file contains:

docs.open-valve.com