Files
goose/documentation/README.md
T
Adewale Abati f7c7799ea6 Documentation for Goose V1 (#638)
Co-authored-by: Wendy Tang <wendytang@squareup.com>
Co-authored-by: Salman Mohammed <smohammed@squareup.com>
Co-authored-by: Yingjie He <yingjiehe@block.xyz>
Co-authored-by: Kalvin C <kalvinnchau@users.noreply.github.com>
Co-authored-by: Nahiyan Khan <nahiyan.khan@gmail.com>
Co-authored-by: Bradley Axen <baxen@squareup.com>
Co-authored-by: lily-de <119957291+lily-de@users.noreply.github.com>
Co-authored-by: Michael Neale <michael.neale@gmail.com>
Co-authored-by: Kalvin Chau <kalvin@squareup.com>
Co-authored-by: marcelle <1852848+laanak08@users.noreply.github.com>
Co-authored-by: Ebony Louis <ebony774@gmail.com>
Co-authored-by: Angie Jones <jones.angie@gmail.com>
2025-01-23 22:14:29 +01:00

768 B

Website

This website is built using Docusaurus, 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.