markdown-magic - npm Package Compare versions

Comparing version 0.1.22 to 0.1.23

lib/transforms/code.js

@@ -48,6 +48,11 @@ "use strict" // eslint-disable-line
 
+  let header = ''
+  if (options.header) {
+    header = `\n${options.header}`
+  }
+
   return `<!-- The below code snippet is automatically added from ${options.src} -->
-\`\`\`${syntax}
+\`\`\`${syntax}${header}
 ${code}
 \`\`\``
 }

lib/transforms/index.js

@@ -15,2 +15,3 @@ "use strict" // eslint-disable-line
    * - `syntax` (optional): Syntax will be inferred by fileType if not specified
+   * - `header` (optional): Will add header comment to code snippet. Useful for pointing to relative source directory or adding live doc links
    *
@@ -17,0 +18,0 @@ * **Example:**

package.json

 {
   "name": "markdown-magic",
-  "version": "0.1.22",
+  "version": "0.1.23",
   "description": "Automatically update markdown files with content from external sources",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -148,2 +148,3 @@ # Markdown Magic [![npm-version][npm-badge]][npm-link]
 - `syntax` (optional): Syntax will be inferred by fileType if not specified
+- `header` (optional): Will add header comment to code snippet. Useful for pointing to relative source directory or adding live doc links
 
@@ -150,0 +151,0 @@ **Example:**

No alert changes

Improved metrics

Total package byte prevSize

58643

increased by0.64%

Lines of code

880

increased by0.57%

Number of lines in readme file

350

increased by0.29%

No dependency changes