History

Srini Kadamati 1720fa68fa docs: fixed URL for contributing landing page (#18600 )		2022-02-07 11:39:42 -05:00
..
docs	docs: fixed URL for contributing landing page (#18600 )	2022-02-07 11:39:42 -05:00
src	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08:00
static	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08: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
README.md	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08:00
babel.config.js	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08:00
docusaurus.config.js	Update docusaurus.config.js (#18577 )	2022-02-03 12:17:37 -08:00
package-lock.json	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08:00
package.json	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08: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	feat: 🚀 Docs V2 CI Script (#18560 )	2022-02-02 13:02:51 -08:00

Website

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

$ yarn

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

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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