Guide

VS Code extension

Edit Markdown as it looks, inside VS Code. Edit text, tables and diagrams directly, and switch to source when needed. Free for personal and business use, including commercial work.

Get started

Search for “Nagi.md” in the VS Code Extensions view and install it, or get it from the Visual Studio Marketplace. To install a VSIX file, use Extensions → … → Install from VSIX. For the Windows installer, extract the entire ZIP and run Install-Nagi.cmd. After installing or updating, save your documents and run Developer: Reload Window from the command palette.

Open a Markdown file (.md or .markdown). If Nagi.md is your default Markdown editor, it opens directly.
If the file opens as source, click the preview button or press Ctrl+K, then V to open Nagi.md to the side. Ctrl+Shift+V opens it in the current editor group.
Click the document to edit. Changes synchronize between the source editor and Nagi.md.

Installing the extension does not change your default Markdown editor. Use Reopen Editor With to select Nagi.md and set it as the default to open files directly next time. Create new documents with the Nagi.md new Markdown command.

On macOS, use ⌘ in place of Ctrl for standard shortcuts. Custom keybindings take precedence.

Saving follows VS Code

Auto save follows files.autoSave. Press Ctrl+S to save manually. For a new document without a save location, press Ctrl+S once to choose a location.

off: No auto save.
afterDelay: Saves after the delay set in files.autoSaveDelay.
onFocusChange: Saves when focus leaves the document, editor or window.
onWindowChange: Saves when the VS Code window becomes inactive.

External changes in separate parts of the document are merged with your input. Conflicting changes keep your input and pause auto save. Choose what to keep in the comparison, resolve the conflict, then save.

Editing and search

Source: the code button in the tab title opens the VS Code source editor. Hold Alt to open it to the side. The </> button inside Nagi.md toggles its internal source view.
Find and replace: with the document focused, use Ctrl+F for Find and Ctrl+H for Replace (⌘+Option+F on macOS). F3 / Shift+F3 moves to the next / previous match.
Tables: click a cell to edit and use Tab for the next cell. Right-click to add or delete rows and columns; drag handles to reorder them.
Diagrams: click a Mermaid or PlantUML diagram to edit its definition and update the rendered view.
Images: paste or drop images. Saved documents offer a destination and format dialog; new documents embed image data.
PDF: use Export → Print in Browser or Save as PDF. Direct PDF output uses an installed Edge, Chrome or Chromium.

Undo and Redo share VS Code's document history. The standard read-only preview remains available through Markdown: Open Preview in the command palette.

See changes in the rendered document

Opening a Markdown diff, including from source control, opens a read-only rendered diff. Additions are green, deletions red, and changed words highlighted. Use the top bar to move between changes. Open Text Diff returns to line comparisons and staging operations.

For documents tracked by Git, the diff button at the top right compares the current document with the last commit (HEAD), including unsaved input. Click again to return to editing.

Main settings

Search for these names in VS Code Settings. Nagi.md commands for search, outline, document width and themes are available from the command palette. Assign keys in Keyboard Shortcuts.

nagi.diffPreview.openAutomatically: Opens rendered diffs automatically. On by default.
nagi.diffPreview.replaceTextDiff: Replaces text diffs with rendered diffs. Turn off to open them alongside text diffs. On by default.
nagi.syncPosition: Synchronizes selection and scroll position with source. On by default.
nagi.pdf.browserPath: Absolute path to the browser executable when PDF browser detection fails.
nagi.windowsAppPath: Path to Nagi.exe for opening the Windows app.

Environments and document protection

Restricted mode is supported. Read-only documents remain read-only. Images and relative links in WSL and SSH retain the original host URI. Appearance preferences support Settings Sync, and the extension adapts to high-contrast themes. Open in App is available in a local Windows environment.

Editing in rendered mode may normalize Markdown in changed parts. Use source view when preserving the exact notation matters. See Apps for supported features across editions. The extension terms (Japanese) are the same as its bundled LICENSE.txt.