Skip to content

Commit c08ed01

Browse files
committed
Move html preview commands docs to vscode docs repo
Follow up on: microsoft/vscode-docs#896 Removes the extended documentation for the html preview since this now lives in the vscode docs
1 parent 3782311 commit c08ed01

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

src/vs/workbench/api/node/extHostApiCommands.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -171,18 +171,7 @@ export class ExtHostApiCommands {
171171
description: `
172172
Render the html of the resource in an editor view.
173173
174-
Links contained in the document will be handled by VS Code whereby it supports \`file\`-resources and
175-
[virtual](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.d.ts#L3295)-resources
176-
as well as triggering commands using the \`command\`-scheme. Use the query part of a command-uri to pass along JSON-encoded
177-
arguments - note that URL-encoding must be applied. The snippet below defines a command-link that calls the _previewHtml_
178-
command and passes along an uri:
179-
\`\`\`
180-
let href = encodeURI('command:vscode.previewHtml?' + JSON.stringify(someUri));
181-
let html = '<a href="' + href + '">Show Resource...</a>.';
182-
\`\`\`
183-
184-
The body element of the displayed html is dynamically annotated with one of the following css classes in order to
185-
communicate the kind of color theme vscode is currently using: \`vscode-light\`, \`vscode-dark\`, or \`vscode-high-contrast\'.
174+
See [working with the html preview](https://code.visualstudio.com/docs/extensionAPI/vscode-api-commands#working-with-the-html-preview) for more information about the html preview's intergration with the editor and for best practices for extension authors.
186175
`,
187176
args: [
188177
{ name: 'uri', description: 'Uri of the resource to preview.', constraint: value => value instanceof URI || typeof value === 'string' },

0 commit comments

Comments
 (0)