specfuse

preview

"Launch the Redocly documentation preview server (port 8081) in the background with live reload for viewing the OpenAPI specs while editing. Use when you want to visually review the API docs in the browser as spec files change."

specfuse 0 Updated 2mo ago
GitHub

Install

npx skillscat add specfuse/authoring/preview

Install via the SkillsCat registry.

SKILL.md

Launch the Redocly documentation preview server for live viewing of the API specifications.

Enforces: (general — no single handbook)

Steps

  1. Start the preview server — Run ./scripts/specfuse/serve-docs.sh in the background using run_in_background: true. The server starts on port 8081 by default.

  2. Confirm it's running — After a few seconds, check the output to verify the server started successfully. Look for the "Preview URL" line.

  3. Inform the user — Tell the user the docs are available at http://localhost:8081 and that changes to spec files will auto-reload.

Notes

  • The server runs in the background so you can continue making changes to the specs.
  • Changes to any YAML file under api/specs/v1/ will trigger a live reload automatically.
  • To stop the server, the user can press Ctrl+C in the terminal or kill the background process.