为markdown-it编写插件

markdown-it的文档和语法确实有点难理解, 我也只琢磨出了我想要的插件的写法, 所以 这篇文章目前应该叫: 为markdown-it编写一个渲染自定义块语法的插件.

什么是markdown-it

就是用来渲染markdown的, 拥有极强的可定制型, 可以为它写插件以支持自定义语法.

它被使用到了:

  • vuepress

问题

项目中需要将md中的yaml转换成json并显示.

md格式如下

    ``` ymal
    a: 1
    ```

希望显示如下

{
  "a": 1
}

ps: 实际上你想将块当中的内容处理成任何东西都可以

这是标准markdown肯定做不了的事情, 所以就需要扩展markdown-it.

理解

首先肯定是要去看官方api文档的, 很快, 你就云里雾里.

我也是看着几个关键字(也就是文档的一级目录, 如Ruler, Token), 再百度搜搜其他资料(如 Markdown-It 的解析过程), 再去看看其他插件是怎么写的, 才猜得略知一二.

介于其他资料只是写了原理, 而没有写如何修改, 所以我就再输出一下我的思路.

Token

Token是最终会被渲染的数据结构

Ruler会将# hello转换为如下token (以简化)

{
  render: 'h1',
  content: 'hello'
}

这个数据格式能很方便的渲染成html.

Ruler

Ruler将md转换为另一个语法: Token

在markdown-ite中Ruler分两种, 分别对应解析block和inline的Ruler

  • block: 多行的语法, 如 code, table 等
  • inline: 单行的语法, 如 # * 等

其中block优先级高, 需要先执行.

如果要自定义插件去解析md, 则一定需要写这个.

Parsing

运行Ruler的东西就叫Parsing, 一个Parsing中有多个Ruler, 他们执行有先后. 在markdown-it中有两个Parsing, 分别是block和inline.

block始终比inline先执行.

Render

Render就是将token渲染成为html.

如果要自定义插件去解析md, 则一定需要写这个.

一个#的渲染函数如下

function render(tokens, idx){
    let content = tokens[idx].content;
    return '<h1>'+content+'</h1>'
}

总结流程

当markdown-it实例创建出来, 就会生成几个默认的东西, ParsingBlock, ParsingInline 以及它们的默认Rulers.

首先运行ParsingBlock之中的Rules去解析一次md, 再运行ParsingInline的Rules, 将两次得到的Token组合在一起(具体怎么组合我没深入了)就可以交由Render渲染了.

如何写

我们如果要自定义语法, 就需要自定义Rules用来解析语法和Render用来渲染语法.

这里我建议读者去参考官方插件的写法, 就这点官方文档, 想从零写插件基本不可能.

  • 容器: 只是给目标内容添加一个包裹层, 不会影响其中内容的渲染, 如果你要做折叠效果的话就应该使用这个语法.
  • 块: 多行语法, 如table, 整个块中的内容就交由这个语法渲染.
  • inline: 一行的语法, 如#

我在做以上需求的时候, 就是抄的markdown-it-math, 不多说了, cv走起.

我再简单讲讲部分代码

只需要两行代码:

// 由于我们要覆盖默认的code的解析器, 所以需要在code之前添加.
md.block.ruler.before('code', 'yaml2json', block);
md.renderer.rules.yaml2json = render;

然后再写100行

  let open = '``` yaml'
  let close = '```'

  function block(state, startLine, endLine, silent) {
    var openDelim, len, params, nextLine, token, firstLine, lastLine, lastLinePos,
      haveEndMarker = false,
      pos = state.bMarks[startLine] + state.tShift[startLine],
      max = state.eMarks[startLine];

    if (pos + open.length > max) {
      return false;
    }

    openDelim = state.src.slice(pos, pos + open.length);

    if (openDelim !== open) {
      return false;
    }

    pos += open.length;
    firstLine = state.src.slice(pos, max);

    // Since start is found, we can report success here in validation mode
    if (silent) {
      return true;
    }

    if (firstLine.trim().slice(-close.length) === close) {
      // Single line expression
      firstLine = firstLine.trim().slice(0, -close.length);
      haveEndMarker = true;
    }

    // search end of block
    nextLine = startLine;

    for (; ;) {
      if (haveEndMarker) {
        break;
      }

      nextLine++;

      if (nextLine >= endLine) {
        // unclosed block should be autoclosed by end of document.
        // also block seems to be autoclosed by end of parent
        break;
      }

      pos = state.bMarks[nextLine] + state.tShift[nextLine];
      max = state.eMarks[nextLine];

      if (pos < max && state.tShift[nextLine] < state.blkIndent) {
        // non-empty line with negative indent should stop the list:
        break;
      }

      if (state.src.slice(pos, max).trim().slice(-close.length) !== close) {
        continue;
      }

      if (state.tShift[nextLine] - state.blkIndent >= 4) {
        // closing block math should be indented less then 4 spaces
        continue;
      }

      lastLinePos = state.src.slice(0, max).lastIndexOf(close);
      lastLine = state.src.slice(pos, lastLinePos);

      pos += lastLine.length + close.length;

      // make sure tail has spaces only
      pos = state.skipSpaces(pos);

      if (pos < max) {
        continue;
      }

      // found!
      haveEndMarker = true;
    }

    // If math block has heading spaces, they should be removed from its inner block
    len = state.tShift[startLine];

    state.line = nextLine + (haveEndMarker ? 1 : 0);

    token = state.push('yaml2json', 'yaml2json', 0);
    token.block = true;
    token.content = (firstLine && firstLine.trim() ? firstLine + '\n' : '') +
      state.getLines(startLine + 1, nextLine, len, true) +
      (lastLine && lastLine.trim() ? lastLine : '');
    token.info = params;
    token.map = [startLine, state.line];
    token.markup = open;

    return true;
  }

block方法我也理解不了, 说实话还是好复杂, 我就cv了刚刚提到的math插件并且删掉了不用的代码 (捂脸)

其实这么多代码只是为了获取从开始标记到结束标记的块的内容.

import yaml from 'js-yaml'

  function render(tokens, idx) {
    let content = tokens[idx].content;
    let y = yaml.load(content)
    let html = JSON.stringify(y, null, 4)
    return '<pre>'+html+'</pre>';
  }

render的入参和出参都和简单, 一看就懂

由于我们覆盖掉了默认的code解析器, 所以就没有代码高亮功能了.

我没有这个需求, 所以我可以这样写, 这样写的好处是不会污染ruler代码.

如果你需要代码高亮功能, 可以不自定义render而使用默认的code的render, 那么解析yaml的代码就应该写在ruler里. 或者你还可以使用 hightlight-js 插件自己去高亮代码.

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341