superset/docs-v2
2022-01-31 10:17:30 -05:00
..
docs Fix broken links (#18230) 2022-01-31 10:17:30 -05:00
src feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
static feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
.gitignore feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
.prettierrc feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
babel.config.js feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
docusaurus.config.js Fix broken links (#18230) 2022-01-31 10:17:30 -05:00
package-lock.json feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
package.json feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
README.md feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
sidebars.js feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
tsconfig.json feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00
yarn.lock feat: Upgrade documentation V2 (#17411) 2022-01-27 14:54:53 -08:00

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.