关于javascript:markdownit-插件如何写三

2次阅读

共计 3106 个字符，预计需要花费 8 分钟才能阅读完成。

在《一篇带你用 VuePress + Github Pages 搭建博客》中，咱们应用 VuePress 搭建了一个博客，最终的成果查看：TypeScript 中文文档。

在搭建博客的过程中，咱们出于理论的需要，在《VuePress 博客优化之拓展 Markdown 语法》中解说了如何写一个 markdown-it 插件，又在《markdown-it 原理解析》中解说了 markdown-it 的执行原理，本篇咱们将解说具体的实战代码，帮忙大家更好的写插件。

markdown-it 的作者提供了 markdown-it-inine 用于不便批改 inline tokens。举个例子，如果咱们给所有的链接增加 target="_blank"，失常你须要这样写：

// Remember old renderer, if overridden, or proxy to default renderer
var defaultRender = md.renderer.rules.link_open || function(tokens, idx, options, env, self) {return self.renderToken(tokens, idx, options);
};

md.renderer.rules.link_open = function (tokens, idx, options, env, self) {
  // If you are sure other plugins can't add `target` - drop check below
  var aIndex = tokens[idx].attrIndex('target');

  if (aIndex < 0) {tokens[idx].attrPush(['target', '_blank']); // add new attribute
  } else {tokens[idx].attrs[aIndex][1] = '_blank';    // replace value of existing attr
  }

  // pass token to default renderer.
  return defaultRender(tokens, idx, options, env, self);
};

应用 markdown-it-for-inline 后：

var iterator = require('markdown-it-for-inline');

var md = require('markdown-it')()
            .use(iterator, 'url_new_win', 'link_open', function (tokens, idx) {var aIndex = tokens[idx].attrIndex('target');

              if (aIndex < 0) {tokens[idx].attrPush(['target', '_blank']);
              } else {tokens[idx].attrs[aIndex][1] = '_blank';
              }
            });

如果咱们要替换掉某个文字，也能够应用 markdown-it-for-inline：

var iterator = require('markdown-it-for-inline');

// plugin params are:
//
// - rule name (should be unique)
// - token type to apply
// - function
//
var md = require('markdown-it')()
            .use(iterator, 'foo_replace', 'text', function (tokens, idx) {tokens[idx].content = tokens[idx].content.replace(/foo/g, 'bar');
            });

Plugin for creating block-level custom containers for markdown-it markdown parser.

markdown-it 的作者同样提供了 markdown-it-container 用于疾速创立块级自定义容器。

有了这个插件，你能够这样应用 markdown 语法：

::: spoiler click me
*content*
:::

留神这其中的 ::: 是插件定义的语法，它会取出 ::: 后的字符，在这个例子中是 warning，并提供办法自定义渲染后果：

var md = require('markdown-it')();

md.use(require('markdown-it-container'), 'spoiler', {validate: function(params) {return params.trim().match(/^spoiler\s+(.*)$/);
  },

  render: function (tokens, idx) {// 通过 tokens[idx].info.trim() 取出 'click me' 字符串
    var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/);

    // 开始标签的 nesting 为 1，完结标签的 nesting 为 -1
    if (tokens[idx].nesting === 1) {
      // 开始标签
      return '<details><summary>' + md.utils.escapeHtml(m[1]) + '</summary>\n';
    } else {
      // 完结标签
      return '</details>\n';
    }
  }
});

最终渲染的后果为：

<details><summary>click me</summary>
<p><em>content</em></p>
</details>

像 VuePress 提供了自定义容器：

其实就是用 markdown-it-container 实现的，其实现源码为：

const container = require('markdown-it-container')

module.exports = md => {
  md
    .use(...createContainer('tip', 'TIP'))
    .use(...createContainer('warning', 'WARNING'))
    .use(...createContainer('danger', 'WARNING'))
        // ...
}

function createContainer (klass, defaultTitle) {
  return [container, klass, {render (tokens, idx) {const token = tokens[idx]
      const info = token.info.trim().slice(klass.length).trim()
      if (token.nesting === 1) {return `<div class="${klass} custom-block"><p class="custom-block-title">${info || defaultTitle}</p>\n`
      } else {return `</div>\n`}
    }
  }]
}

博客搭建系列是我至今写的惟一一个偏实战的系列教程，预计 20 篇左右，解说如何应用 VuePress 搭建、优化博客，并部署到 GitHub、Gitee、公有服务器等平台。本篇为第 18 篇，全系列文章地址：https://github.com/mqyqingfeng/Blog

微信：「mqyqingfeng」，加我进冴羽惟一的读者群。

如果有谬误或者不谨严的中央，请务必给予斧正，非常感激。如果喜爱或者有所启发，欢送 star，对作者也是一种激励。

正文完