lage/docs
renovate[bot] 17b9a107af
Update docusaurus monorepo to v2.3.0 (#552)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-01 12:38:21 -08:00
..
docs fixes typo in Cookbook/migration/mdx (#546) 2023-01-26 16:47:26 -08:00
src Switch transpilation to swc for build performance (#477) 2022-11-04 18:02:31 -07:00
static moving the beta docs to be real docs! 2022-09-18 20:35:19 -07:00
.gitignore New docs migration (#231) 2022-03-14 15:02:41 -07:00
README.md New docs migration (#231) 2022-03-14 15:02:41 -07:00
babel.config.js New docs migration (#231) 2022-03-14 15:02:41 -07:00
docusaurus.config.js moving the beta docs to be real docs! 2022-09-18 20:35:19 -07:00
lage.config.js moving the beta docs to be real docs! 2022-09-18 20:35:19 -07:00
package.json Update docusaurus monorepo to v2.3.0 (#552) 2023-02-01 12:38:21 -08:00
sidebars.js New docs migration (#231) 2022-03-14 15:02:41 -07:00
tailwind.config.js moving the beta docs to be real docs! 2022-09-18 20:35:19 -07:00
tsconfig.json moving the beta docs to be real docs! 2022-09-18 20:35:19 -07:00

README.md

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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.