hermes-agent/website
Teknium cad3f8a37f
docs(site): disable highlightSearchTermsOnTargetPage to keep URLs clean (#12661)
The @easyops-cn/docusaurus-search-local option appends ?_highlight=<term>
query params to links from the search bar. Docusaurus puts the query string
before the #anchor, producing URLs like

    /docs/foo?_highlight=bar#section

which look broken when copy-pasted. Turn the option off — Ctrl+F on the
landing page covers the same use case without polluting shareable links.
2026-04-19 11:56:34 -07:00
..
docs docs(providers): call out Bedrock as not covered by request_timeout_seconds 2026-04-19 11:23:00 -07:00
scripts feat(website): add skills browse and search page to docs (#4500) 2026-04-02 10:47:38 -07:00
src fix: light mode link/primary colors unreadable on white background (#10457) 2026-04-15 11:17:44 -07:00
static docs: stabilize website diagrams 2026-03-14 22:49:57 -07:00
.gitignore chore: gitignore generated skills.json 2026-04-02 10:48:15 -07:00
docusaurus.config.ts docs(site): disable highlightSearchTermsOnTargetPage to keep URLs clean (#12661) 2026-04-19 11:56:34 -07:00
package-lock.json docs: stabilize website diagrams 2026-03-14 22:49:57 -07:00
package.json docs: stabilize website diagrams 2026-03-14 22:49:57 -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: add PR review guides, rework quickstart, slim down installation 2026-04-19 05:30:50 -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.