markdown-it-attrs - npm Package Compare versions

Comparing version 2.4.1 to 3.0.0

.nyc_output/processinfo/index.json

@@ -1,1 +0,1 @@
-{"processes":{"cbc8dc59-1d97-429d-bca4-d744ac635210":{"parent":null,"children":["f753f5b6-486e-4d32-8b12-868e61807b3d"]},"f753f5b6-486e-4d32-8b12-868e61807b3d":{"parent":"cbc8dc59-1d97-429d-bca4-d744ac635210","children":[]}},"files":{"/Users/arve/git/markdown-it-attrs/index.js":["f753f5b6-486e-4d32-8b12-868e61807b3d"],"/Users/arve/git/markdown-it-attrs/patterns.js":["f753f5b6-486e-4d32-8b12-868e61807b3d"],"/Users/arve/git/markdown-it-attrs/utils.js":["f753f5b6-486e-4d32-8b12-868e61807b3d"]},"externalIds":{}}
+{"processes":{"c67f6449-591c-4ce3-b45c-9e9e9fdfdb2c":{"parent":null,"children":["e1b1cdf6-6c35-47cf-b62d-9114c2d85e44"]},"e1b1cdf6-6c35-47cf-b62d-9114c2d85e44":{"parent":"c67f6449-591c-4ce3-b45c-9e9e9fdfdb2c","children":[]}},"files":{"/Users/arve/git/markdown-it-attrs/index.js":["e1b1cdf6-6c35-47cf-b62d-9114c2d85e44"],"/Users/arve/git/markdown-it-attrs/patterns.js":["e1b1cdf6-6c35-47cf-b62d-9114c2d85e44"],"/Users/arve/git/markdown-it-attrs/utils.js":["e1b1cdf6-6c35-47cf-b62d-9114c2d85e44"]},"externalIds":{}}

demo.js

@@ -1,2 +0,1 @@
-'use strict';
 let md = require('markdown-it')();
@@ -3,0 +2,0 @@ let markdownItAttrs = require('markdown-it-attrs');

markdown-it-attrs.browser.js

@@ -810,8 +810,5 @@ (function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.markdownItAttrs = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
     return tokens[i];
-  } // inline tokens changes level on same token
-  // that have .nesting +- 1
+  }
 
-
-  var level = tokens[i].block ? tokens[i].level : tokens[i].level + 1; // adjust for inline tokens
-
+  var level = tokens[i].level;
   var type = tokens[i].type.replace('_close', '_open');
@@ -818,0 +815,0 @@

package.json

 {
   "name": "markdown-it-attrs",
-  "version": "2.4.1",
+  "version": "3.0.0",
   "description": "Add classes, identifiers and attributes to your markdown with {} curly brackets, similar to pandoc's header attributes",
@@ -46,3 +46,3 @@ "main": "index.js",
     "eslint": "^5.16.0",
-    "markdown-it": "^8.4.2",
+    "markdown-it": "^9.0.0",
     "markdown-it-implicit-figures": "^0.9.0",
@@ -53,5 +53,5 @@ "mocha": "*",
   "peerDependencies": {
-    "markdown-it": "^8.4.2"
+    "markdown-it": "^9.0.0"
   },
   "tonicExampleFilename": "demo.js"
 }

README.md

@@ -169,3 +169,38 @@ # markdown-it-attrs [![Build Status](https://travis-ci.org/arve0/markdown-it-attrs.svg?branch=master)](https://travis-ci.org/arve0/markdown-it-attrs) [![npm version](https://badge.fury.io/js/markdown-it-attrs.svg)](http://badge.fury.io/js/markdown-it-attrs) [![Coverage Status](https://coveralls.io/repos/github/arve0/markdown-it-attrs/badge.svg?branch=master)](https://coveralls.io/github/arve0/markdown-it-attrs?branch=master)
 
+## Custom rendering
+If you would like some other output, you can override renderers:
 
+```js
+const md = require('markdown-it')();
+const markdownItAttrs = require('markdown-it-attrs');
+
+md.use(markdownItAttrs);
+
+// custom renderer for fences
+md.renderer.rules.fence = function (tokens, idx, options, env, slf) {
+  const token = tokens[idx];
+  return  '<pre' + slf.renderAttrs(token) + '>'
+    + '<code>' + token.content + '</code>'
+    + '</pre>';
+}
+
+let src = [
+  '',
+  '```js {.abcd}',
+  'var a = 1;',
+  '```'
+].join('\n')
+
+console.log(md.render(src));
+```
+
+Output:
+```html
+<pre class="abcd"><code>var a = 1;
+</code></pre>
+```
+
+Read more about [custom rendering at markdown-it](https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer).
+
+
 ## Custom blocks
@@ -172,0 +207,0 @@ `markdown-it-attrs` will add attributes to any `token.block == true` with {}-curlies in end of `token.info`. For example, see [markdown-it/rules_block/fence.js](https://github.com/markdown-it/markdown-it/blob/760050edcb7607f70a855c97a087ad287b653d61/lib/rules_block/fence.js#L85) which [stores text after the three backticks in fenced code blocks to `token.info`](https://markdown-it.github.io/#md3=%7B%22source%22%3A%22%60%60%60js%20%7B.red%7D%5Cnfunction%20%28%29%20%7B%7D%5Cn%60%60%60%22%2C%22defaults%22%3A%7B%22html%22%3Afalse%2C%22xhtmlOut%22%3Afalse%2C%22breaks%22%3Afalse%2C%22langPrefix%22%3A%22language-%22%2C%22linkify%22%3Atrue%2C%22typographer%22%3Atrue%2C%22_highlight%22%3Atrue%2C%22_strict%22%3Afalse%2C%22_view%22%3A%22debug%22%7D%7D).

utils.js

@@ -243,8 +243,3 @@ 'use strict';
 
-  // inline tokens changes level on same token
-  // that have .nesting +- 1
-  let level = tokens[i].block
-    ? tokens[i].level
-    : tokens[i].level + 1;  // adjust for inline tokens
-
+  let level = tokens[i].level;
   let type = tokens[i].type.replace('_close', '_open');
@@ -251,0 +246,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

109280

increased by0.16%

Number of lines in readme file

236

increased by17.41%

Worsened metrics

Lines of code

1500

decreased by-0.4%

No dependency changes