Skip to content

README.md

Latest commit

 

History

History
40 lines (24 loc) · 897 Bytes

README.md

File metadata and controls

40 lines (24 loc) · 897 Bytes

Deity Documentation

Overview

This repository contains the documentation for Deity services, including Deity cloud, Falcon Client and Falcon Server.

How the docs work

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

Installation

yarn

Local Development

yarn start

This command starts a local development server and open 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

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.