iamcco/markdown-preview.nvim

Ability to only preview open folds

Open

#15 opened on Feb 10, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (246 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,538 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi,

My use case is that I have a very large markdown file (300,000+ words). Think of it as an entire book in a single file where I have L1 headers as chapters.

I often close all of the folds except for the chapter that I'm actively writing, and Vim is smart enough to only perform a lot of actions on open folds.

It would be amazing if you could add in a feature / option to your plugin so that it only previews open folds. Maybe some type of option like let g:mkdp_preview_closed_folds = 1, which acts exactly how it does now, but when set to 0 then only open folders will be previewed.

Contributor guide

Research direction
Examine how the plugin currently generates the preview HTML from the markdown buffer. Investigate Neovim's 'foldclosed()' function to determine if a line is within a closed fold. Then modify the preview generation to skip content inside closed folds when the option is enabled.
Tech stack
javascript
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitVim scriptJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70