Vim Markdown高亮显示(列表项和代码块冲突)

时间:2020-03-06 14:46:03  来源:igfitidea点击:

我决定学习更多有关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

我目前无法弄清楚如何以我想要的方式使突出显示起作用

忘记添加下面列出的两个规则中使用的"全局"语法规则。确保a以空行开头。

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中说:

"如果在同一位置有多个匹配项,则
确定的LAST胜利。因此,我们可以通过以下方式覆盖先前定义的语法项:
使用与相同文本匹配的项目。但是,关键字始终位于
匹配或者区域。并且具有匹配大小写的关键字始终位于
忽略大小写的关键字。"

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