History

Alex Rothberg e89f0abf95 docs(building): link frontend asset instructions correctly (#19050 )		2022-03-07 12:39:39 -08:00
..
docs	docs(building): link frontend asset instructions correctly (#19050 )	2022-03-07 12:39:39 -08:00
src	docs: renamed yugabytedb to yugabyte as per request by Yugabyte team (#18983 )	2022-03-01 12:19:33 -05:00
static	chore: Remove legacy SIP-15 interim logic/flags (#18936 )	2022-03-04 09:15:36 +13: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	docs: add GA conf to config (#18861 )	2022-02-23 10:33:12 +02:00
package-lock.json	chore(deps): bump url-parse from 1.5.7 to 1.5.10 in /docs (#19019 )	2022-03-03 12:53:29 -07:00
package.json	refactor(docs): clean up deploy of static files (#18923 )	2022-02-24 14:01:26 +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	chore(deps): bump url-parse from 1.5.7 to 1.5.10 in /docs (#19019 )	2022-03-03 12:53:29 -07: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.