metalsmith-markdown-partials 2.0.3 → 2.0.4

package/.nyc_output/processinfo/{9d928c88-3cb5-4d77-8d43-36a76d50ab03.json → a0da4073-c568-4956-847a-81fd95f3459d.json}

@@ -1 +1 @@
-{"parent":null,"pid":46842,"argv":["/Users/wernerglinka/.nvm/versions/node/v16.13.0/bin/node","/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/node_modules/.bin/mocha","./tests/index.js"],"execArgv":[],"cwd":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials","time":1644364249222,"ppid":46841,"coverageFilename":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/.nyc_output/9d928c88-3cb5-4d77-8d43-36a76d50ab03.json","externalId":"","uuid":"9d928c88-3cb5-4d77-8d43-36a76d50ab03","files":["/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js"]}
+{"parent":null,"pid":61877,"argv":["/Users/wernerglinka/.nvm/versions/node/v16.13.0/bin/node","/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/node_modules/.bin/mocha","./tests/index.js"],"execArgv":[],"cwd":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials","time":1644605272274,"ppid":61876,"coverageFilename":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/.nyc_output/a0da4073-c568-4956-847a-81fd95f3459d.json","externalId":"","uuid":"a0da4073-c568-4956-847a-81fd95f3459d","files":["/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js"]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"9d928c88-3cb5-4d77-8d43-36a76d50ab03":{"parent":null,"children":[]}},"files":{"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js":["9d928c88-3cb5-4d77-8d43-36a76d50ab03"]},"externalIds":{}}
+{"processes":{"a0da4073-c568-4956-847a-81fd95f3459d":{"parent":null,"children":[]}},"files":{"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js":["a0da4073-c568-4956-847a-81fd95f3459d"]},"externalIds":{}}

package/README.md

@@ -1,30 +1,12 @@
 # metalsmith-markdown-partials
 
-This Metalsmith plugin enables the use of Markdown partials, e.g. Markdown fragments can be inserted into the contents section of a page markdown file via an include marker.
+A Metalsmith plugin that enables the use of Markdown partials.
 
 [![metalsmith: plugin][metalsmith-badge]][metalsmith-url]
 [![npm: version][npm-badge]][npm-url]
-[![license: MIT][license-badge]][license-url]
+[![license: ISC][license-badge]][license-url]
 
-```
-{#md "<file name>.md" #}
-```
-
-This allows for modular markdown and promotes reuse of markdown partials.
-
-## Page Markdown File
-
-A markdown file that will be transformed into an html file via a template
-
-## Markdown Partial
-
-A markdown file to be inserted into a Page Markdown file
-
-Markdown partials are located in a separate directory, for example `/markdown-library/`. This directory should be located inside `/src/` .
-
-Partial markdown files have the extention `.md`. A markdown partial file does NOT have frontmatter metadata, only the markdown to be inserted into a page markdown file.
-
-The markdown partials directory's default location is `./src/markdown-library/`. The partials directory can be set via the libraryPath option.
+Markdown fragments are be inserted into the contents of a page markdown file by replacing an include marker with markdown partials. This allows for modular markdown and promotes reuse of content.
 
 ## Installation
 
@@ -75,7 +57,27 @@ const mdPartials = require('metalsmith-markdown-partials').use(
 
 ## How it works
 
-### index.md
+### Replacement marker
+```
+{#md "<file name>.md" #}
+```
+
+### Page Markdown File
+A markdown file that will be transformed into an html file via a template
+
+### Markdown Partial
+
+A markdown file to be inserted into a Page Markdown file
+
+Markdown partials are located in a separate directory, for example `/markdown-library/`. This directory should be located inside `/src/` .
+
+Partial markdown files have the extention `.md`. A markdown partial file does NOT have frontmatter metadata, only the markdown to be inserted into a page markdown file.
+
+The markdown partials directory's default location is `./src/markdown-library/`. The partials directory can be set via the libraryPath option.
+
+## Example
+
+**index.md**
 
 ```markdown
 # This is an Example Page
@@ -87,7 +89,7 @@ Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus
 Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
 ```
 
-### example_partial.md
+**example_partial.md**
 
 ```markdown
 ## Inserted Content
@@ -95,7 +97,7 @@ Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac fa
 Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae elit libero, a pharetra augue.
 ```
 
-### index.html
+**index.html**
 
 ```html
 <h1>This is an Example Page</h1>
@@ -115,8 +117,39 @@ Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae
   parturient montes, nascetur ridiculus mus.
 </p>
 ```
+## Debug
+
+To enable debug logs, set the `DEBUG` environment variable to `metalsmith-markdown-partials`:
+
+Linux/Mac:
+
+```
+DEBUG=metalsmith-markdown-partials
+```
+
+Windows:
+
+```
+set "DEBUG=metalsmith-markdown-partials"
+```
+### CLI usage
+
+To use this plugin with the Metalsmith CLI, add `metalsmith-markdown-partials` to the `plugins` key in your `metalsmith.json` file:
+
+```json
+{
+  "plugins": [
+    {
+      "metalsmith-markdown-partials": {
+        "libraryPath": "./markdown-partials/",
+        "fileSuffix": ".md.njk"
+      }
+    }
+  ]
+}
+```
 
-## Credits
+## Author
 
 - [werner@glinka.co](https://github.com/wernerglinka)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "A Metalsmith plugin that allows the use of partial markdowm files",
   "keywords": [
     "metalsmith-plugin",