VS Code extension
The repository's Remarp extension provides syntax highlighting, slide navigation, preview, source building, outline, completion, and issue annotations for source editing. Use the package manifest as the authority for registered commands, settings, and shortcuts.
Local setup
cd tools/remarp-vscode
npm install
npm run compile
Open the extension project in VS Code and launch the Extension Development Host, or package/install a VSIX using the extension tooling. The checked-in package declares its VS Code engine requirement and publisher; documentation does not establish that a particular package is currently published in the Marketplace.
Commands and shortcuts
| Command ID | Function |
|---|---|
remarp.preview | Open approximate text preview |
remarp.previewCompiled | Save, build and preview compiled HTML |
remarp.nextSlide | Move to next slide |
remarp.prevSlide | Move to previous slide |
remarp.build | Build HTML |
remarp.submitIssues | Show the slide-fix guide |
The manifest registers Ctrl/Cmd+Shift+Right and Left for slide navigation, and Ctrl/Cmd+Shift+B for build while the editor language is Remarp. It does not register the previously documented Ctrl/Cmd+Shift+E shortcut.
Settings
| Setting | Default | Purpose |
|---|---|---|
remarp.buildScriptPath | Empty | Explicit absolute converter path, before automatic discovery |
remarp.scrollSync | true | Synchronize source cursor and preview slide |
remarp.autoPreview and remarp.buildOnSave are not current contributed settings.
Editing and issues
Preview includes notes and slide-specific issue annotations. <!-- issue: ... --> records a repair request for slide-fix. Edit the Markdown/CSS/Canvas source, rebuild, and inspect the generated HTML in a browser.
Compiled preview uses the generated HTML and shared runtime/assets, with no Visual Edit controls or writeback. Re-run the command after source changes; the approximate text preview updates as you type.
Boundaries
The extension recognizes .remarp.md, _presentation.md, _presentation.remarp.md, and .md with remarp: true. Builds save dirty project sources and build the directory beside a presentation marker, opening index.html; standalone source opens slides/default.html. Failed saves/builds show errors and stop compiled preview. Builds and preview scripts require workspace trust. Preview, outline and navigation ignore separators inside code fences. Validate final browser behavior separately.