goose/documentation
2025-10-23 18:33:52 -04:00
..
.goose/memory Prompt Library (#1906) 2025-03-31 07:29:37 -04:00
blog docs: Update Discord link (#5335) 2025-10-23 12:37:45 -04:00
docs Docs: goose session export and goose session import (#5267) 2025-10-23 18:33:52 -04:00
plugins Update Recipe Cookbook Submission Flow (#3064) 2025-06-27 19:31:20 -04:00
src docs: Update Discord link (#5335) 2025-10-23 12:37:45 -04:00
static Feat: goose Apify MCP integration docs (#5047) 2025-10-16 10:02:28 +01:00
.gitignore Docs: Revamp extensions site (#1260) 2025-03-24 14:56:40 +01:00
.goosehints Add .goosehints file to enforce lowercase branding in documentation (#4870) 2025-09-28 23:53:56 -04:00
.npmrc feat: V1.0 (#734) 2025-01-24 13:04:43 -08:00
AGENTS.md adding brand guidelines to AGENTS.md (#4887) 2025-10-08 15:27:19 -04:00
docusaurus.config.ts docs: Update Discord link (#5335) 2025-10-23 12:37:45 -04:00
package-lock.json chore(deps): bump brace-expansion from 1.1.11 to 1.1.12 in /documentation (#4149) 2025-08-18 02:25:51 -04:00
package.json feat: add copy as markdown button to documentation pages (#5158) 2025-10-14 13:13:34 -04:00
postcss.config.js Docs: Revamp extensions site (#1260) 2025-03-24 14:56:40 +01:00
README.md Trigger docs deployment 2025-08-27 13:08:10 -04:00
sidebars.ts feat: V1.0 (#734) 2025-01-24 13:04:43 -08:00
tailwind.config.js Docs: Add Goose Recipes Cookbook Page (#2998) 2025-06-20 16:46:27 -04:00
tsconfig.json Prompt Library (#1906) 2025-03-31 07:29:37 -04:00
yarn.lock feat: add copy as markdown button to documentation pages (#5158) 2025-10-14 13:13:34 -04:00

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.