Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.13 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.13 KB

OpenQDA User Documentation

The user manual / documentation of OpenQDA

Deploy to GitHub Pages GitHub License

Website

The documentation is available under https://openqda.github.io/user-docs/

It's built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.