pt/superset
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2024-09-06 13:57:40 -04:00
Code Issues Packages Projects Releases Wiki Activity
9f02ff656d
superset/docs
History
Maxime Beauchemin df00f0e7ab
docs: facelift the docs (#20180) 
* docs: facelift the docs

* lint

* license headers
2022-06-06 09:01:21 -06:00
..
docs Fixes #20155 (#20273) 2022-06-06 07:57:54 -03:00
src docs: facelift the docs (#20180) 2022-06-06 09:01:21 -06:00
static docs: facelift the docs (#20180) 2022-06-06 09:01:21 -06:00
.gitignore feat: 🚀 Docs V2 CI Script (#18560) 2022-02-02 13:02:51 -08:00
.prettierrc docs(new docs site): removes old sphinx doc site with gatsby (#10784) 2020-09-11 22:59:12 -07:00
babel.config.js feat: 🚀 Docs V2 CI Script (#18560) 2022-02-02 13:02:51 -08:00
docusaurus.config.js docs: facelift the docs (#20180) 2022-06-06 09:01:21 -06:00
package.json docs: facelift the docs (#20180) 2022-06-06 09:01:21 -06:00
README.md docs: update lock + general cleanup (#19350) 2022-03-24 15:43:30 +02:00
sidebars.js feat: 🚀 Docs V2 CI Script (#18560) 2022-02-02 13:02:51 -08:00
tsconfig.json feat: 🚀 Docs V2 CI Script (#18560) 2022-02-02 13:02:51 -08:00
yarn.lock docs: facelift the docs (#20180) 2022-06-06 09:01:21 -06:00

README.md

Website

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

Installation

$ yarn install

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.