iamcco/markdown-preview.nvim

Feature Request: Highlighting

Open

#352 opened on Jun 18, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (5,538 stars) (246 forks)batch import
help wanted

Description

It would be quaint if the preview highlights, or somehow emphasizes, the text we select through a visual block in Vim.

Markdown is often written with one line per sentence, while the preview lets us see how it looks in a more natural format. Sometimes I struggle to find the sentence I'm editing in the preview, so it would be nice with a little feature that helps me locate where my Vim cursor is at.

PS. Great plugin, 10/10.

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Neovim plugin development knowledgeFamiliarity with markdown preview.nvim's event handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how the plugin updates the preview on cursor movement. The key file is likely `lua/markdown preview/init.lua` or similar, where events like `CursorMoved` are handled. Look for the function that sends the current line to the preview server. To add highlighting, you would need to pass the line number or a unique marker to the preview HTML, then use JavaScript in the preview to highlight that line. The preview server is likely in `app/server.js`. Check existing issues or PRs for similar cursor related features.