hermes-agent/website
xiangyong de0ac21fff docs(docker): document API_SERVER_* env vars for exposing the OpenAI-compatible endpoint
Salvage of #11758. The PR's original diff was stale (the Docker Compose section on main has been heavily refactored — dashboard is now an embedded side-process, not a separate service), so the useful bit (API server env var requirements) is applied as a note on the basic `docker run` example.

Co-authored-by: xiangyong <xiangyong@zspace.cn>
2026-05-05 13:48:37 -07:00
..
docs docs(docker): document API_SERVER_* env vars for exposing the OpenAI-compatible endpoint 2026-05-05 13:48:37 -07:00
scripts docs(skills): explain restoring bundled skills 2026-05-05 13:46:20 -07:00
src docs(website): add User Stories and Use Cases collage page (#18282) 2026-04-30 23:56:59 -07:00
static docs(model-catalog): rename x-ai/grok-4.20-beta to x-ai/grok-4.20 (#19640) 2026-05-04 02:48:30 -07:00
.gitignore docs: publish llms.txt and llms-full.txt for agent-friendly ingestion (#18276) 2026-04-30 23:17:14 -07:00
docusaurus.config.ts docs: exclude per-skill pages from search, add curator feature page (#17563) 2026-04-29 10:28:15 -07:00
package-lock.json docs: stabilize website diagrams 2026-03-14 22:49:57 -07:00
package.json fix(website): run skill extraction automatically on npm run build/start (#13747) 2026-04-21 18:02:04 -07:00
README.md docs: replace ASCII diagrams with Mermaid/lists, add linting note 2026-03-21 17:58:30 -07:00
sidebars.ts docs(teams): add Teams to sidebar 2026-05-04 20:59:18 -07:00
tsconfig.json feat: add documentation website (Docusaurus) 2026-03-05 05:24:55 -08: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.

Diagram Linting

CI runs ascii-guard to lint docs for ASCII box diagrams. Use Mermaid (````mermaid`) or plain lists/tables instead of ASCII boxes to avoid CI failures.