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

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "hexo-renderer-markdown-it",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.",
@@ -5,0 +5,0 @@ "main": "index",

README.md

@@ -6,6 +6,16 @@ # hexo-renderer-markdown-it
 ## Installation
+In it's current version, [Hexo] with `hexo-renderer-marked` predefined as a markdown renderer.
 
+To use `hexo-renderer-markdown-it` you will have to:
+
+- Remove `hexo-renderer-marked`
 ``` bash
+$ npm uninstall hexo-renderer-marked --save
+```
+
+- Install `hexo-renderer-markdown-it`
+``` bash
 $ npm install hexo-renderer-markdown-it --save
 ```
+- Configure the plugin using the template in the configuration section.
 
@@ -23,16 +33,16 @@ ## Configuration
 MarkdownIt:
-  # Enable HTML tags in source
-  html: false,
-  # Use '/' to close single tags (<br />).
-  # This is only for full CommonMark compatibility.
+  # Enable HTML tags in source. Also needed so hexo can process code tags and
+  # shortcodes.
+  html: true,
+  # Use '/' to close single tags (<br />). This is only for full CommonMark
+  # compatibility.
   xhtmlOut: false,
-  # Convert '\n' in paragraphs into <br>
+  # Convert '\n' (newline) in paragraphs into <br>
   breaks: false,
-  # CSS language prefix for fenced blocks. Can be
-  # useful for external highlighters.
-  langPrefix: 'language-',  
+  # CSS language prefix for fenced blocks. Useful for external highlighters.
+  langPrefix: '',  
   # Autoconvert URL-like text to links
-  linkify: false,
-  # Enable some language-neutral replacement + quotes beautification
-  typographer: false,
+  linkify: true,
+  # Enable some language-neutral replacement & quotes beautification
+  typographer: true,
   # Double + single quotes replacement pairs, when typographer enabled,
@@ -39,0 +49,0 @@ # and smartquotes on. Set doubles to '«»' for Russian, '„“' for German.

No alert changes

Improved metrics

Total package byte prevSize

4844

9.22%

Number of lines in readme file

55

22.22%

No dependency changes