Vim Markdown 高亮（列表项和代码块冲突）

StackOverflow https://stackoverflow.com/questions/137952

题

我决定更多地了解 vim 及其语法突出显示。使用其他人的示例，我正在为 Markdown 创建自己的语法文件。我见过 mkd.vim 它也有这个问题。我的问题是列表项和代码块突出显示之间。

代码块 定义:

  • 第一行是空白
  • 第二行以至少 4 个空格或 1 个制表符开头
  • 块以空行结束

例子：

Regular text

    this is code, monospaced and left untouched by markdown
    another line of code

Regular Text

我的代码块的 Vim 语法：

syn match mkdCodeBlock   /\(\s\{4,}\|\t\{1,}\).*\n/ contained nextgroup=mkdCodeBlock  

hi link mkdCodeBlock  comment

无序列表项目 定义:

  • 第一行是空白
  • 第二行以 [-+*] 开头，后跟一个空格
  • 列表以空行结束，然后是普通（非列表）行
  • 在行项目之间可以添加任意数量的空行
  • 子列表通过缩进指定（4 个空格或 1 个制表符）
  • 列表项后面的一行普通文本作为该列表项的延续包含在内

例子：

Regular text

- item 1

    - sub item 1
    - sub item 2
- item 2
this is part of item 2
so is this


- item 3, still in the same list
    - sub item 1
    - sub item 2

Regular text, list ends above

我的无序列表项定义的 Vim 语法（我只突出显示 [-+*]):

syn region  mkdListItem start=/\s*[-*+]\s\+/ matchgroup=pdcListText end=".*" contained nextgroup=mkdListItem,mkdListSkipNL contains=@Spell skipnl 
syn match mkdListSkipNL /\s*\n/ contained nextgroup=mkdListItem,mkdListSkipNL skipnl

hi link mkdListItem  operator

我无法突出显示与列表的最后两条规则和代码块一起使用。

这是一个破坏我的语法突出显示的示例：

Regular text

- Item 1
- Item 2
part of item 2

    - these 2 line should be highlighted as a list item
    - but they are highlighted as a code block

我目前无法弄清楚如何让突出显示按照我想要的方式工作

忘记添加下面列出的两个规则中使用的“全局”语法规则。这是为了确保它们以空行开头。

syn match mkdBlankLine   /^\s*\n/    nextgroup=mkdCodeBlock,mkdListItem transparent

另一个注意事项：我应该说得更清楚。在我的语法文件中，列表规则出现在块引用规则之前

有帮助吗？

解决方案

只需确保 mkdListItem 的定义位于 mkdCodeBlock 的定义之后，如下所示：

syn match mkdCodeBlock   /\(\s\{4,}\|\t\{1,}\).*\n/ contained nextgroup=mkdCodeBlock  
hi link mkdCodeBlock  comment

syn region  mkdListItem start=/\s*[-*+]\s\+/ matchgroup=pdcListText end=".*" contained nextgroup=mkdListItem,mkdListSkipNL contains=@Spell skipnl 
syn match mkdListSkipNL /\s*\n/ contained nextgroup=mkdListItem,mkdListSkipNL skipnl
hi link mkdListItem  operator

syn match mkdBlankLine   /^\s*\n/    nextgroup=mkdCodeBlock,mkdListItem transparent

Vim 文档中说 :help :syn-define:

“如果多个项目在同一位置匹配，则定义的最后一项胜利。因此，您可以使用与同一文本匹配的项目覆盖先前定义的语法项目。但是，一个关键字总是在比赛或区域之前进行。一个带有匹配案例的关键字总是在关键字之前使用忽略案例。”

其他提示

hcs42 是正确的。我确实记得现在读过该部分，但我忘记了，直到 hcs24 提醒我。

这是我更新的有效语法（其他一些调整）：

"""""""""""""""""""""""""""""""""""""""
" Code Blocks:

"   Indent with at least 4 space or 1 tab
"   This rule must appear for mkdListItem, or highlighting gets messed up
syn match mkdCodeBlock   /\(\s\{4,}\|\t\{1,}\).*\n/ contained nextgroup=mkdCodeBlock  

"""""""""""""""""""""""""""""""""""""""
" Lists:

"   These first two rules need to be first or the highlighting will be
"   incorrect

"   Continue a list on the current line or next line
syn match mkdListCont /\s*[^-+*].*/ contained nextgroup=mkdListCont,mkdListItem,mkdListSkipNL contains=@Spell skipnl transparent

"   Skip empty lines
syn match mkdListSkipNL /\s*\n/ contained nextgroup=mkdListItem,mkdListSkipNL 

"   Unorder list
syn match  mkdListItem /\s*[-*+]\s\+/ contained nextgroup=mkdListSkipNL,mkdListCont  skipnl

Tai Zhyn，这可能涵盖了您的用例，但不涵盖 Markdown 语法。在 Markdown 中的列表项 可以 包含一个代码块。你可以看看我的解决方案 这里

TL;博士;问题是 vim 不允许你说这样的话： 与其容器具有相同缩进的块 + 4 个空格. 。我找到的唯一解决方案是为每种类型的块生成规则，这些块可以包含在每个缩进级别的列表项中（实际上我支持 42 级缩进，但它是任意数字）

所以我有 markdownCodeBlockInListItemAtLevel1 必须 包含在 markdownListItemAtLevel1 中，并且需要至少有 8 个前导空格，然后是 markdownCodeBlockInListItemAtLevel2 必须 包含在 markdownListItemAtLevel2 中，而 markdownListItemAtLevel2 必须包含在 markdownListItemAtLevel1 中，ant 需要至少有 10 个前导空格，ecc...

我知道几年过去了，但也许有人会认为这个答案很有帮助，因为所有基于缩进的语法都遇到同样的问题

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top