Skip to content

docs: add deno desktop reference page (2.8)#3085

Open
lunadogbot wants to merge 1 commit intodenoland:mainfrom
lunadogbot:docs/2.8-deno-desktop
Open

docs: add deno desktop reference page (2.8)#3085
lunadogbot wants to merge 1 commit intodenoland:mainfrom
lunadogbot:docs/2.8-deno-desktop

Conversation

@lunadogbot
Copy link
Copy Markdown

Summary

Adds a reference page for the new (experimental) deno desktop subcommand from the 2.8 milestone (denoland/deno#33441). The page documents the public-facing surface in the upstream PR and explicitly marks it experimental, since the API is still evolving.

Covered:

  • Quick start, including framework-detection mode (deno desktop .).
  • The three rendering backends — cef, webview, raw — and how WEF binaries are downloaded/cached.
  • Framework auto-detection list (Next.js, Astro, Fresh, Remix, Nuxt, SvelteKit, SolidStart, TanStack Start, Vite SSR) and the --hmr flow.
  • The Deno.BrowserWindow API surface (window lifecycle, bind/unbind RPC, executeJs, menus, native handle), plus Deno.dock and Deno.Tray.
  • Native prompt() / alert() / confirm() and the desktop.errorReporting.url hook.
  • Unified DevTools (--inspect / --inspect-brk / --inspect-wait).
  • Auto-updater (Deno.autoUpdate, Deno.desktopVersion).
  • Cross-compile and per-platform output formats (.app / .dmg / .exe / .AppImage).
  • The desktop config block in deno.json.

Also notes what is not yet implemented (codesigning, MSI, deb/rpm, notifications, clipboard, secureStorage).

Sidebar entry in runtime/_data.ts, entry in the CLI index page.

Test plan

  • deno task serve — page renders, sidebar entry resolves.
  • Page will need a follow-up sweep once the upstream PR settles. Marked experimental at the top so readers don't take it as gospel.

Adds a CLI reference page for the new (experimental) deno desktop
subcommand which builds self-contained desktop apps from a Deno
project. Documents the three rendering backends (cef / webview / raw),
framework auto-detection, HMR, the Deno.BrowserWindow / Deno.Tray /
Deno.dock APIs, the unified DevTools session, the auto-updater, the
cross-compile output formats, and the new \`desktop\` block in
deno.json. Marks the surface as still evolving. Adds entries to the
CLI index and sidebar.

Refs denoland/deno#33441
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