hexo-renderer-markdown-it - npm Package Compare versions

Comparing version 3.4.1 to 4.0.0

index.js

@@ -0,4 +1,31 @@
+/* global hexo */
+
 'use strict';
-var renderer = require('./lib/renderer');
 
+hexo.config.markdown = Object.assign({
+  render: {},
+  anchors: {}
+}, hexo.config.markdown);
+
+hexo.config.markdown.render = Object.assign({
+  html: true,
+  xhtmlOut: false,
+  breaks: true,
+  linkify: true,
+  typographer: true,
+  quotes: '“”‘’'
+}, hexo.config.markdown.render);
+
+hexo.config.markdown.anchors = Object.assign({
+  level: 2,
+  collisionSuffix: '',
+  permalink: false,
+  permalinkClass: 'header-anchor',
+  permalinkSymbol: '¶',
+  case: 0,
+  separator: ''
+}, hexo.config.markdown.anchors);
+
+const renderer = require('./lib/renderer');
+
 hexo.extend.renderer.register('md', 'html', renderer, true);
@@ -5,0 +32,0 @@ hexo.extend.renderer.register('markdown', 'html', renderer, true);

lib/anchors.js

 'use strict';
 
-var assign = require('lodash.assign');
-var Token = require('markdown-it/lib/token');
-var sluggo = require('sluggo');
+const Token = require('markdown-it/lib/token');
+const { slugize } = require('hexo-util');
 
-var renderPermalink = function (slug, opts, tokens, idx) {
-  return tokens[idx + 1].children.unshift(assign(new Token('link_open', 'a', 1), {
+const renderPermalink = function(slug, opts, tokens, idx) {
+  return tokens[idx + 1].children.unshift(Object.assign(new Token('link_open', 'a', 1), {
     attrs: [['class', opts.permalinkClass], ['href', '#' + slug]]
-  }), assign(new Token('text', '', 0), {
+  }), Object.assign(new Token('text', '', 0), {
     content: opts.permalinkSymbol
-  }), new Token('link_close', 'a', -1), assign(new Token('text', '', 0), {
+  }), new Token('link_close', 'a', -1), Object.assign(new Token('text', '', 0), {
     content: ''
@@ -17,23 +16,22 @@ }));
 
-var anchor = function (md, opts) {
-  opts = assign({}, anchor.defaults, opts);
+const anchor = function(md, opts) {
+  Object.assign(opts, { renderPermalink });
 
-  var titleStore = {};
-  var originalHeadingOpen = md.renderer.rules.heading_open;
+  const titleStore = {};
+  const originalHeadingOpen = md.renderer.rules.heading_open;
+  const slugOpts = { transform: opts.case, ...opts };
 
-  md.renderer.rules.heading_open = function (tokens, idx, something, somethingelse, self) {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
+  md.renderer.rules.heading_open = function(...args) {
+    const [tokens, idx, something, somethingelse, self] = args; // eslint-disable-line no-unused-vars
 
     if (tokens[idx].tag.substr(1) >= opts.level) {
-      var _tokens$idx;
+      let _tokens$idx;
 
-      var title = tokens[idx + 1].children.reduce(function (acc, t) {
+      const title = tokens[idx + 1].children.reduce((acc, t) => {
         return acc + t.content;
       }, '');
 
-      var slug = sluggo(title);
+      let slug = slugize(title, slugOpts);
 
-      if (titleStore.hasOwnProperty(slug)) {
+      if (Object.prototype.hasOwnProperty.call(titleStore, slug)) {
         titleStore[slug] = titleStore[slug] + 1;
@@ -47,3 +45,3 @@ slug = slug + '-' + opts.collisionSuffix + titleStore[slug].toString();
       (_tokens$idx = tokens[idx], !_tokens$idx.attrs && (_tokens$idx.attrs = []), _tokens$idx.attrs)
-      .push(['id', slug]);
+        .push(['id', slug]);
 
@@ -55,17 +53,8 @@ if (opts.permalink) {
 
-    return (originalHeadingOpen) ?
-      originalHeadingOpen.apply(this, args) :
-      self.renderToken.apply(self, args);
+    return originalHeadingOpen
+      ? originalHeadingOpen.apply(this, args)
+      : self.renderToken.apply(self, args);
   };
 };
 
-anchor.defaults = {
-  level: 1,
-  collisionSuffix: 'v',
-  permalink: false,
-  renderPermalink: renderPermalink,
-  permalinkClass: 'header-anchor',
-  permalinkSymbol: '¶'
-};
-
 module.exports = anchor;

lib/renderer.js

 'use strict';
 
-module.exports = function (data, options) {
-  var MdIt = require('markdown-it');
-  var cfg = this.config.markdown;
-  var opt = (cfg) ? cfg : 'default';
-  var parser = (opt === 'default' || opt === 'commonmark' || opt === 'zero') ?
-    new MdIt(opt) :
-    new MdIt(opt.render);
+module.exports = function(data, options) {
+  const MdIt = require('markdown-it');
+  const cfg = this.config.markdown;
+  const opt = cfg ? cfg : 'default';
+  let parser = opt === 'default' || opt === 'commonmark' || opt === 'zero'
+    ? new MdIt(opt)
+    : new MdIt(opt.render);
 
   if (opt.plugins) {
-    parser = opt.plugins.reduce(function (parser, pugs) {
+    parser = opt.plugins.reduce((parser, pugs) => {
+      if (pugs instanceof Object && pugs.name) {
+        return parser.use(require(pugs.name), pugs.options);
+      }
       return parser.use(require(pugs));
+
     }, parser);
@@ -15,0 +19,0 @@ }

package.json

 {
   "name": "hexo-renderer-markdown-it",
-  "version": "3.4.1",
+  "version": "4.0.0",
   "description": "Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.",
-  "main": "index",
+  "main": "index.js",
   "scripts": {
-    "test": "gulp test"
+    "eslint": "eslint .",
+    "test": "mocha test/index.js",
+    "test-cov": "nyc npm run test"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/celsomiranda/hexo-renderer-markdown-it.git"
+    "url": "git://github.com/hexojs/hexo-renderer-markdown-it.git"
   },
-  "engines": {
-    "node": ">= 0.10.0"
-  },
   "keywords": [
@@ -23,33 +22,39 @@ "hexo",
   ],
+  "directories": {
+    "lib": "./lib"
+  },
+  "files": [
+    "index.js",
+    "lib/"
+  ],
   "author": "Celso Miranda <[e-mail]> (http://celsomiranda.net/)",
-  "license": {
-    "type": "MIT",
-    "url": "https://raw.github.com/celsomiranda/hexo-renderer-markdown-it/master/LICENSE"
-  },
+  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/celsomiranda/hexo-renderer-markdown-it/issues"
+    "url": "https://github.com/hexojs/hexo-renderer-markdown-it/issues"
   },
-  "homepage": "https://github.com/celsomiranda/hexo-renderer-markdown-it",
+  "homepage": "https://github.com/hexojs/hexo-renderer-markdown-it",
   "dependencies": {
-    "lodash.assign": "^3.2.0",
-    "markdown-it": "^5.0.1",
-    "markdown-it-abbr": "^1.0.0",
-    "markdown-it-footnote": "^2.0.0",
-    "markdown-it-ins": "^2.0.0",
+    "hexo-util": "^1.7.0",
+    "markdown-it": "^10.0.0",
+    "markdown-it-abbr": "^1.0.4",
+    "markdown-it-cjk-breaks": "^1.1.2",
+    "markdown-it-container": "^2.0.0",
+    "markdown-it-deflist": "^2.0.3",
+    "markdown-it-emoji": "^1.4.0",
+    "markdown-it-footnote": "^3.0.1",
+    "markdown-it-ins": "^3.0.0",
+    "markdown-it-mark": "^3.0.0",
     "markdown-it-sub": "^1.0.0",
-    "markdown-it-sup": "^1.0.0",
-    "sluggo": "^0.2.0"
+    "markdown-it-sup": "^1.0.0"
   },
   "devDependencies": {
-    "chai": "^3.2.0",
-    "coveralls": "^2.11.4",
-    "del": "^2.1.0",
-    "gulp": "^3.9.0",
-    "gulp-istanbul": "^0.10.0",
-    "gulp-jshint": "^1.11.2",
-    "gulp-load-plugins": "^1.0.0-rc.1",
-    "gulp-mocha": "^2.1.3",
-    "jshint-stylish": "^2.0.1",
-    "mocha": "^2.2.5"
+    "chai": "^4.0.0",
+    "eslint": "^6.0.1",
+    "eslint-config-hexo": "^4.0.0",
+    "mocha": "^6.0.2",
+    "nyc": "^14.1.1"
+  },
+  "engines": {
+    "node": ">=8.6.0"
   }
 }

README.md

 # hexo-renderer-markdown-it
 
-[![Build Status](https://travis-ci.org/celsomiranda/hexo-renderer-markdown-it.svg)](https://travis-ci.org/celsomiranda/hexo-renderer-markdown-it)
-[![npm version](https://badge.fury.io/js/hexo-renderer-markdown-it.svg)](http://badge.fury.io/js/hexo-renderer-markdown-it) [![npm dependencies](https://david-dm.org/celsomiranda/hexo-renderer-markdown-it.svg)](https://www.npmjs.com/package/hexo-renderer-markdown-it)
-[![Coverage Status](https://coveralls.io/repos/celsomiranda/hexo-renderer-markdown-it/badge.svg)](https://coveralls.io/r/celsomiranda/hexo-renderer-markdown-it)
+[![Build Status](https://travis-ci.org/hexojs/hexo-renderer-markdown-it.svg?branch=master)](https://travis-ci.org/hexojs/hexo-renderer-markdown-it)
+[![npm version](https://badge.fury.io/js/hexo-renderer-markdown-it.svg)](https://www.npmjs.com/package/hexo-renderer-markdown-it)
+[![npm dependencies](https://david-dm.org/hexojs/hexo-renderer-markdown-it.svg)](https://david-dm.org/hexojs/hexo-renderer-markdown-it)
+[![Coverage Status](https://coveralls.io/repos/github/hexojs/hexo-renderer-markdown-it/badge.svg?branch=master)](https://coveralls.io/github/hexojs/hexo-renderer-markdown-it?branch=master)
 
 This renderer plugin uses [Markdown-it] as a render engine on [Hexo]. Adds support for [Markdown] and [CommonMark].
 
-## Documentation
-This `README` was getting too messy for my taste, so it was time to fire up the github wiki in the repo and [move the documentation over there](https://github.com/celsomiranda/hexo-renderer-markdown-it/wiki).
-
 ## Main Features
@@ -24,8 +22,30 @@ - Support for [Markdown], [GFM] and [CommonMark]
 ## Installation
-You can install `hexo-renderer-markdown-it` by following [these steps in the documentation](https://github.com/celsomiranda/hexo-renderer-markdown-it/wiki/Getting-Started).
+Follow the [installation guide](https://github.com/hexojs/hexo-renderer-markdown-it/wiki/Getting-Started).
 
-It's also the place to go if you want to know more about how `hexo-renderer-markdown-it` works.
+## Options
 
+``` yml
+markdown:
+  render:
+    html: true
+    xhtmlOut: false
+    breaks: true
+    linkify: true
+    typographer: true
+    quotes: '“”‘’'
+  plugins:
+  anchors:
+    level: 2
+    collisionSuffix: ''
+    permalink: false,
+    permalinkClass: 'header-anchor'
+    permalinkSymbol: '¶'
+    case: 0
+    separator: ''
+```
+
+Refer to [the wiki](https://github.com/hexojs/hexo-renderer-markdown-it/wiki) for more details.
+
 ## Requests and bug reports
-If you have any feature requests or bugs to report, [you're welcome to file an issue](https://github.com/celsomiranda/hexo-renderer-markdown-it/issues).
+If you have any feature requests or bugs to report, you're welcome to [file an issue](https://github.com/hexojs/hexo-renderer-markdown-it/issues).
 
@@ -32,0 +52,0 @@

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8083

2.52%

Dev dependency count

5

-50%

Lines of code

95

18.75%

Number of lines in readme file

57

54.05%

Worsened metrics

Dependency count

12

50%

Number of package files

6

-25%

Number of low supply chain risk alerts

2

100%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  hexo-util@^1.7.0

• + Added

  markdown-it-cjk-breaks@^1.1.2

• + Added

  markdown-it-container@^2.0.0

• + Added

  markdown-it-deflist@^2.0.3

• + Added

  markdown-it-emoji@^1.4.0

• + Added

  markdown-it-mark@^3.0.0

• + Added

  bluebird@3.7.2
  (transitive)

• + Added

  camel-case@4.1.2
  (transitive)

• + Added

  cross-spawn@7.0.6
  (transitive)

• + Added

  deepmerge@4.3.1
  (transitive)

• + Added

  dom-serializer@1.4.1
  (transitive)

• + Added

  domelementtype@2.3.0
  (transitive)

• + Added

  domhandler@3.3.04.3.1
  (transitive)

• + Added

  domutils@2.8.0
  (transitive)

• + Added

  eastasianwidth@0.2.0
  (transitive)

• + Added

  entities@2.0.32.2.0
  (transitive)

• + Added

  hexo-util@1.9.1
  (transitive)

• + Added

  highlight.js@9.18.5
  (transitive)

• + Added

  htmlparser2@4.1.0
  (transitive)

• + Added

  isexe@2.0.0
  (transitive)

• + Added

  linkify-it@2.2.0
  (transitive)

• + Added

  lower-case@2.0.2
  (transitive)

• + Added

  markdown-it@10.0.0
  (transitive)

• + Added

  markdown-it-cjk-breaks@1.1.3
  (transitive)

• + Added

  markdown-it-container@2.0.0
  (transitive)

• + Added

  markdown-it-deflist@2.1.0
  (transitive)

• + Added

  markdown-it-emoji@1.4.0
  (transitive)

• + Added

  markdown-it-footnote@3.0.3
  (transitive)

• + Added

  markdown-it-ins@3.0.1
  (transitive)

• + Added

  markdown-it-mark@3.0.1
  (transitive)

• + Added

  min-indent@1.0.1
  (transitive)

• + Added

  no-case@3.0.4
  (transitive)

• + Added

  pascal-case@3.1.2
  (transitive)

• + Added

  path-key@3.1.1
  (transitive)

• + Added

  prismjs@1.30.0
  (transitive)

• + Added

  punycode.js@2.3.1
  (transitive)

• + Added

  shebang-command@2.0.0
  (transitive)

• + Added

  shebang-regex@3.0.0
  (transitive)

• + Added

  strip-indent@3.0.0
  (transitive)

• + Added

  striptags@3.2.0
  (transitive)

• + Added

  tslib@2.8.1
  (transitive)

• + Added

  which@2.0.2
  (transitive)

• - Removed

  lodash.assign@^3.2.0

• - Removed

  sluggo@^0.2.0

• - Removed

  entities@1.1.2
  (transitive)

• - Removed

  linkify-it@1.2.4
  (transitive)

• - Removed

  lodash._baseassign@3.2.0
  (transitive)

• - Removed

  lodash._basecopy@3.0.1
  (transitive)

• - Removed

  lodash._bindcallback@3.0.1
  (transitive)

• - Removed

  lodash._createassigner@3.1.1
  (transitive)

• - Removed

  lodash._getnative@3.9.1
  (transitive)

• - Removed

  lodash._isiterateecall@3.0.9
  (transitive)

• - Removed

  lodash.assign@3.2.0
  (transitive)

• - Removed

  lodash.isarguments@3.1.0
  (transitive)

• - Removed

  lodash.isarray@3.0.4
  (transitive)

• - Removed

  lodash.keys@3.1.2
  (transitive)

• - Removed

  lodash.restparam@3.6.1
  (transitive)

• - Removed

  markdown-it@5.1.0
  (transitive)

• - Removed

  markdown-it-footnote@2.0.0
  (transitive)

• - Removed

  markdown-it-ins@2.0.0
  (transitive)

• - Removed

  sluggo@0.2.0
  (transitive)

• Updated

  markdown-it@^10.0.0

• Updated

  markdown-it-abbr@^1.0.4

• Updated

  markdown-it-footnote@^3.0.1

• Updated

  markdown-it-ins@^3.0.0