docs: add deno desktop reference page (2.8)#3085
Open
lunadogbot wants to merge 1 commit intodenoland:mainfrom
Open
docs: add deno desktop reference page (2.8)#3085lunadogbot wants to merge 1 commit intodenoland:mainfrom
deno desktop reference page (2.8)#3085lunadogbot wants to merge 1 commit intodenoland:mainfrom
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a reference page for the new (experimental)
deno desktopsubcommand 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:
deno desktop .).cef,webview,raw— and how WEF binaries are downloaded/cached.--hmrflow.Deno.BrowserWindowAPI surface (window lifecycle,bind/unbindRPC,executeJs, menus, native handle), plusDeno.dockandDeno.Tray.prompt()/alert()/confirm()and thedesktop.errorReporting.urlhook.--inspect/--inspect-brk/--inspect-wait).Deno.autoUpdate,Deno.desktopVersion)..app/.dmg/.exe/.AppImage).desktopconfig block indeno.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.