masukomi / masukomi/vim-markdown-folding

Option to turn of folding for headline tags mark with ---

Open
#3 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vim Script
Stars
257
Forks
44
PR merge metrics
No merged PRs in 30d

Description

Hi Drew I really love your plugin and I'm using it on my daily basis for writing articles in markdown. Since I'm using [Jekyll](http://jekyllrb.com/) for running my blog, I'm also using the YAML settings at the beginning of each markdown file.

```

---
layout: post
title: here goes the article of a new post
meta-description: <---- Here begins the first fold level because of the special headline marks

---

## The kitchen timer <-- here should be the first level of the folding level

...
```

If you have problems with following the example above, please consult the example below:

  1 ---

2 layout: post
3 title: On My Way On Becoming a Self-Certified Pomodoro Master
4 ## meta-description: Motivation for the ongoing series of becoming a Self-Certiefied Pomodoro Master [12 lines]-----------
17 ## Why? [22 lines]--------------------------------------------------------------------------------------------------------
40 ## The First Pomodoro [36 lines]------------------------------------------------------------------------------------------
77 ## Following the six objectives [17 lines]--------------------------------------------------------------------------------
95 ## Conclusion [9 lines]---------------------------------------------------------------------------------------------------

Cheers

Matthias

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the vim-markdown-folding folding logic and configuration entry points for how YAML front matter and headline tags are recognized. Reproduce the example with Jekyll front matter, then verify that the requested option prevents folding there while preserving folding for normal Markdown headings.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.