Getting Started

Getting Started

Requirements

• Visual Studio Code 1.90 or newer
• A PDF with a selectable text layer
• No account or translation service is required for basic reading and annotation

Install from a VSIX

1. Download the VSIX from the latest GitHub release.
2. In VS Code, open the Command Palette.
3. Run Extensions: Install from VSIX... and select the downloaded file.
4. Run Developer: Reload Window once after installation.

You can also install from a terminal:

code --install-extension /path/to/inleaf-reader.vsix --force

Open a PDF

1. Open a PDF in VS Code.
2. Click the blue nested-book icon in the editor title bar.

Alternatively, right-click a PDF in the Explorer and choose Inleaf Reader: Open Paper Reader.

The reading interface

• Prev / Next: move one page at a time.
• Page: jump directly to a page number.
• − / +: zoom out or in.
• Fit: fit the page to the available width.
• Show panel: open annotations, wordbook, filters, and translation settings.

The right panel starts hidden so the document remains the main focus.

Your first annotation

1. Select text in the PDF.
2. Choose Highlight, Underline, or Note from the inline toolbar.
3. Continue reading. The annotation is saved automatically.

See Reading and Annotations for editing, deletion, tags, exports, and OCR-related limitations.

Updating a locally built VSIX

Run build and packaging commands from the repository directory, not from the folder containing your PDFs:

cd /path/to/inleaf-reader
npm ci
npm run package:vsix -- --out /tmp/inleaf-reader.vsix
code --install-extension /tmp/inleaf-reader.vsix --force

Then run Developer: Reload Window.