mirror of
https://github.com/block/goose.git
synced 2026-05-19 16:27:54 +00:00
| .. | ||
| .goose/memory | ||
| automation | ||
| blog | ||
| docs | ||
| plugins | ||
| scripts | ||
| src | ||
| static | ||
| .gitignore | ||
| .goosehints | ||
| .npmrc | ||
| AGENTS.md | ||
| docusaurus.config.ts | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| README.md | ||
| sidebars.ts | ||
| tailwind.config.js | ||
| tsconfig.json | ||
Website
This website is built using Docusaurus, a modern static website generator.
Run all commands from the documentation/ directory.
Installation
$ npm i
Local Development
$ npm run 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
$ npm run 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 npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run 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.