goose/documentation
2026-01-08 15:57:20 -05:00
..
.goose/memory Prompt Library (#1906) 2025-03-31 07:29:37 -04:00
automation workflow: auto-update recipe-reference on release (#5988) 2025-12-15 12:11:00 -08:00
blog Blog: edit links in mcp apps post (#6371) 2026-01-07 12:16:18 -05:00
docs Update MCP apps tutorial: fix _meta structure and version prereq (#6404) 2026-01-08 15:57:20 -05:00
plugins docs: RPI tutorial (#6261) 2025-12-23 22:56:12 -06:00
scripts markdown export from URL (#5830) 2025-11-21 15:37:41 -06:00
src docs: slash commands topic (#6333) 2026-01-05 16:59:35 -08:00
static docs: RPI tutorial (#6261) 2025-12-23 22:56:12 -06:00
.gitignore chore: remove yarn usage from documentation (#5555) 2025-11-03 17:03:15 -05: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(blog): Agentic Guardrails and Controls (#6329) 2026-01-05 10:13:40 -05:00
package-lock.json chore(deps): bump qs and body-parser in /documentation (#6338) 2026-01-05 15:12:16 -05:00
package.json chore(deps): bump js-yaml in /documentation (#6093) 2025-12-15 09:39:32 -08:00
postcss.config.js Docs: Revamp extensions site (#1260) 2025-03-24 14:56:40 +01:00
README.md chore: remove yarn usage from documentation (#5555) 2025-11-03 17:03:15 -05: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

Website

This website is built using Docusaurus, a modern static website generator.

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.