superset/docs/README.md
Hugh A. Miles II 9c3205b573
feat: 🚀 Docs V2 CI Script (#18560)
* switch to v2

* promote docv2

* remove on triggers
2022-02-02 13:02:51 -08:00

1.4 KiB

Website

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

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