Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 2.38 KB

README.md

File metadata and controls

72 lines (42 loc) · 2.38 KB
Raw

Cadence docs · Build and Deploy Nightly integration test

cadenceworkflow.io

Cadence docs is built using Docusaurus.

Installation

$ npm install

Local Development

$ npm run start

This command starts a local development server and opens up a browser window at http://localhost:3000/. 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.

Environment Variables

In order to deploy to multiple environments, some configuration options in docusaurus.config.ts are made available for override through environment variables.

# Can be replaced by your GH pages url, ie. https://<userId>.github.io/
CADENCE_DOCS_URL=https://cadenceworkflow.io

# For GitHub pages deployment, it is often /<projectName>/ defaults to `/`
BASE_URL=/cadence-docs/

# For Github pages only, this is your Github org/user name.
ORGANIZATION_NAME=cadence-workflow

Deployment

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

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

NPM Registry

Ensure you have a .npmrc file configured with registry=https://registry.npmjs.org/. This will ensure the dependencies are pulled from the correct source and to prevent internal npm registries from being pushed onto the package-lock.json

License

MIT License, please see LICENSE for details.