@canopycanopycanopy/b-ber-grammar-media 3.0.8-nav.0 → 3.0.8-next.61

package/README.md

@@ -1,9 +1,20 @@
-# `@canopycanopycanopy/b-ber-grammar-media`
+# b-ber-grammar-media
 
-The `b-ber-grammar-media` package renders b-ber's custom `audio` and `video` Markdown extensions (directives) into HTML. More information about b-ber directives can be found in the [All directives](https://github.com/triplecanopy/b-ber/wiki/all-directives) page in the b-ber [Wiki](https://github.com/triplecanopy/b-ber/wiki).
+Handles the `media` and `media-inline` pseudo-directives, which are build-target-aware aliases resolved before the MarkdownIt parse step. Rather than emitting HTML directly, this package performs a text substitution pass over the raw Markdown string: it finds each `media` or `media-inline` directive, looks up the corresponding entry in `state.media` (populated from the project's `media.yml` file), and replaces the directive with the correct concrete directive (e.g. `vimeo`, `audio`, `figure`) for the current build target. The substituted Markdown is then parsed normally by the rest of the grammar pipeline. This allows authors to write a single `media` directive and have it resolve to different embed types per build.
 
-## Install
+## Usage
 
+Called by the Markdown rendering pipeline before MarkdownIt processing:
+
+```js
+import media from '@canopycanopycanopy/b-ber-grammar-media'
+media.render(markdownString) // returns updated Markdown string
 ```
-$ npm i -g @canopycanopycanopy/b-ber-grammar-media
+
+## Dev
+
 ```
+npm test
+```
+
+Tests are in `__tests__/index.test.js`.

package/dist/index.js

@@ -129,7 +129,6 @@ function render(data) {
   }
   return str;
 }
-var _default = {
+var _default = exports.default = {
   render
-};
-exports.default = _default;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-grammar-media",
-  "version": "3.0.8-nav.0+24db1e6b",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -26,9 +26,9 @@
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.10.5",
-    "@canopycanopycanopy/b-ber-lib": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-nav.0+24db1e6b",
+    "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-next.61+2bbec564",
     "lodash": "^4.17.21",
     "tar": "^6.1.11"
   },
@@ -49,5 +49,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "24db1e6bb491faae0d52c6dadc09d974a5a31cf5"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }