Skip to content

docs(html): add server rendering usage#1014

Open
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-html-api-docs
Open

docs(html): add server rendering usage#1014
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-html-api-docs

Conversation

@cerredz
Copy link
Copy Markdown

@cerredz cerredz commented May 16, 2026

Contributes to #851.

What changed

  • Adds a server-side rendering usage section for @cycle/html.
  • Shows makeHTMLDriver() receiving rendered markup and sending an HTML response.
  • Clarifies that the HTML driver exposes a DOMSource-compatible source with empty event streams on the server.
  • Keeps docs/api/html.html in sync with docs/content/api/html.md.

Verification

  • node --check .scripts/make-api-docs.js
  • git diff --check

Note

I attempted to regenerate the HTML API page with node .scripts/make-api-docs.js html, but the existing docs toolchain fails before writing output because the installed dox dependency throws TypeError: parse is not a function. I therefore mirrored the Markdown addition into the rendered HTML without changing the existing generated API block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant