scriptoriumadmin/ReMe
1
0
Fork 0
mirror of https://github.com/agentscope-ai/ReMe.git synced 2026-10-13 04:01:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
ReMe/github-pages
History
Sen Huang 73abbe68a8
Merge f2e247028f into c1de31ab2c
2026-10-10 13:39:56 +08:00
..
public docs: show ReMe ecosystem on homepage (#568) 2026-09-24 11:58:05 +08:00
scripts Merge f2e247028f into c1de31ab2c 2026-10-10 13:39:56 +08:00
tests Merge f2e247028f into c1de31ab2c 2026-10-10 13:39:56 +08:00
.gitignore docs: add standalone GitHub Pages site (#448) 2026-08-12 11:55:35 +08:00
ecosystem-assets.md docs: show ReMe ecosystem on homepage (#568) 2026-09-24 11:58:05 +08:00
package-lock.json docs: rebuild documentation site with VitePress (#518) 2026-09-04 14:50:50 +08:00
package.json feat(studio): add bilingual browser demo to documentation site (#581) 2026-10-03 22:34:11 +08:00
README.md feat(studio): add bilingual browser demo to documentation site (#581) 2026-10-03 22:34:11 +08:00

README.md

ReMe documentation site

This package builds the VitePress site published at https://reme.agentscope.io. The canonical documentation lives in docs/; selected product, integration, plugin, and benchmark READMEs are mirrored into a disposable source tree during the build. Do not edit .generated/ or dist/.

Requirements

  • Node.js 22.13 or newer
  • npm

Local development

cd github-pages
npm ci
npm ci --prefix ../reme_studio
npm run dev

The development server prints its local URL. Restart it after changing a mirrored README or reme/config/default.yaml so the generated source tree and Job reference are refreshed. Changes under docs/ are also refreshed on restart.

Validation

npm test
npm run build
npm run preview

The test suite verifies bilingual core pages, canonical-source mappings, generated Job coverage, and disposable output. The production build is written to github-pages/dist/ for the existing GitHub Pages workflow. Development and build commands also compile the shared Studio UI in browser-demo mode and include it at /studio/; install both packages' dependencies before running them. The demo needs no ReMe service or model credentials.

Sources

  • docs/: canonical guides, VitePress configuration, theme, and brand assets
  • reme/config/default.yaml: generated callable Job reference
  • reme_studio/README*.md: ReMe Studio documentation
  • reme_studio/demo/: browser data adapter, bilingual Markdown examples, tags, and scripted conversations
  • integrations/{dsh,openclaw}/README*.md: TypeScript host plugins
  • plugins/*/README*.md: plugin guides
  • benchmark/*/README*.md: benchmark guides
  • scripts/generate-content.mjs: source mirroring and reference generation

When adding a canonical guide, add both docs/zh/<name>.md and docs/en/<name>.md, then include it in the appropriate sidebar in docs/.vitepress/config.mts. Add repository-owned READMEs to externalDocuments in the generator rather than duplicating their full content under docs/.

Deployment

.github/workflows/deploy-docs.yml uses the reusable documentation build workflow and publishes dist/ to GitHub Pages. public/CNAME preserves the reme.agentscope.io custom domain.