Document ReviewOpen HTML, PDF and Word reports in VS Code, and comment on them as you read. The comments go into a JSON file next to the report, for a colleague or an AI agent to work through.
Supported filesThese open in the preview when you open them in VS Code:
To open an HTML file as text, click Open Source in the editor's title bar, or turn off Open By Default in the settings. To open a file in the app your computer uses for it, such as Word for a Reading a reportThe toolbar above the pages shows the page you are on. Type a page number into its box and press Enter to go there. At the right, the magnifiers zoom out and in, and a click on the zoom between them returns to 100%. Fit width and Fit page fit the pages to the editor, and keep them fitted as you resize it. A PDF opens fitted to the editor's width, and a Word document at 100%. The Document Outline in the Explorer lists the report's headings. Click one to go to its section. As you scroll, the outline highlights the section you are reading. The preview shows each new version of the file in place, as when you render a Quarto report again, and keeps your page and zoom. A tab you switch away from opens where you left it, even after you restart VS Code. Finding textCmd+F (Ctrl+F on Windows and Linux) opens the find bar. It highlights every match and counts them, and Enter and Shift+Enter step through them. Match Case and Match Whole Word sit in the box, as in VS Code's own find. A search of a PDF covers every page, not only the ones you have scrolled to.
Dark themesIn a dark theme, the half-filled circle at the right of the toolbar turns white pages dark, in every PDF and Word preview at once. Colours keep their hue, so a blue line in a plot stays blue. A Word document's images keep their own colours, while a PDF's images change with the page.
Commenting on a reportComments let you review a report where you read it, without marking up the report itself. The comment buttons sit in the editor's title bar, for every format:
Commented text is highlighted. Click it to read the comment. From there you can edit it, resolve it or delete it.
The Document Outline lists the comments under the sections they are in, with the comments on the whole report first. A comment moves to Not found at the end when the report no longer holds its text, usually because the author rewrote it. The outline's badge counts the open comments. Each row has buttons to resolve or delete its comment, and the buttons above the outline add a comment, delete the resolved ones, and open the comments as a list. The list of commentsThe comments live in a file beside the report:
Handing the comments to an author or an AI agentThe review file is plain JSON, made for whoever changes the report's source, such as a Quarto, R Markdown or Typst file. Point your colleague or your AI agent at it and ask them to work through the open comments. Each comment says what it is about and where, so they can find the place in the source without you pointing to it. For each comment they address, they set its status to resolved and write what they changed in its reply. The preview shows the replies as soon as they save the file.
A comment with no HTML reportsAn HTML report shows as in a browser, with the images, styles and scripts beside it, so a Quarto or R Markdown report with interactive tables and plots works as it does in a browser. Its scripts run only once you trust the workspace. A link to another file beside it, such as the PDF of the same report, opens that file in VS Code. An HTML report fills the whole preview, with no toolbar above it. Its zoom buttons sit in the editor's title bar instead, beside the comment button and Open Source. Open Preview to the Side shows the preview beside the HTML source, and the preview follows your edits as you type, before you save. SettingsSearch for "Document Review" in VS Code's settings.
Your documentsDocument Review never changes your documents. Comments go in their own file beside the report. The extension itself never connects to the internet. An HTML report may load images, fonts or scripts from the web, as it would in a browser. Remote windows and large filesA report opens quickly however large it is, and in a remote window, such as SSH, WSL or a dev container, VS Code moves only what you read:
|




