Website

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

It is hosted at: https://openhousedb.org

Local Development

First install npm packages:

$ npm install

To bring up the service, run:

$ 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. Server should be brought up at http://localhost:3000/

Adding new documentation

Follow user guide in docusaurus.io/docs to add new documentation. Particularly Pages, Docs, Blog.

A special flavor of markdown MDX is used by default for all md files by Docusaurus. It is more powerful with its javascript integration.

Updating OpenAPI Specification

Instructions to update specification can be found at /specs.