@canopycanopycanopy/b-ber-grammar-iframe 3.0.8-nav-memo.2 → 3.0.8-next.61

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -4
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,9 +1,20 @@
1
- # `@canopycanopycanopy/b-ber-grammar-iframe`
1
+ # b-ber-grammar-iframe
2
2
 
3
- The `b-ber-grammar-iframe` package renders b-ber's custom `iframe` 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).
3
+ Handles the `iframe` and `iframe-inline` custom Markdown directives. The `iframe` form adds the embed to the figures list (state) and emits a small linked thumbnail pointing to a generated figure page, for display in the List of Illustrations. The `iframe-inline` form emits a fully rendered `<iframe>` element inline in the content — but only for `reader` and `web` builds; other build targets receive an unsupported-content placeholder. Attributes such as `height`, `width`, `title`, `poster`, and standard iframe attributes are parsed and forwarded to the rendered element. Uses `b-ber-parser-figure` as the MarkdownIt plugin.
4
4
 
5
- ## Install
5
+ ## Usage
6
6
 
7
+ Registered as a MarkdownIt plugin by the rendering engine:
8
+
9
+ ```js
10
+ import iframe from '@canopycanopycanopy/b-ber-grammar-iframe'
11
+ // { plugin, name: 'iframe', renderer }
7
12
  ```
8
- $ npm i -g @canopycanopycanopy/b-ber-grammar-iframe
13
+
14
+ ## Dev
15
+
9
16
  ```
17
+ npm test
18
+ ```
19
+
20
+ Tests are in `__tests__/index.test.js`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@canopycanopycanopy/b-ber-grammar-iframe",
3
- "version": "3.0.8-nav-memo.2+63b04c68",
3
+ "version": "3.0.8-next.61+2bbec564",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -25,11 +25,11 @@
25
25
  "rimraf": "^2.7.1"
26
26
  },
27
27
  "dependencies": {
28
- "@canopycanopycanopy/b-ber-grammar-attributes": "3.0.8-nav-memo.2+63b04c68",
29
- "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.2+63b04c68",
30
- "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.2+63b04c68",
31
- "@canopycanopycanopy/b-ber-parser-figure": "3.0.8-nav-memo.2+63b04c68",
32
- "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-nav-memo.2+63b04c68",
28
+ "@canopycanopycanopy/b-ber-grammar-attributes": "3.0.8-next.61+2bbec564",
29
+ "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
30
+ "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
31
+ "@canopycanopycanopy/b-ber-parser-figure": "3.0.8-next.61+2bbec564",
32
+ "@canopycanopycanopy/b-ber-shapes-directives": "3.0.8-next.61+2bbec564",
33
33
  "fs-extra": "^8.1.0",
34
34
  "lodash": "^4.17.21",
35
35
  "lodash.isundefined": "^3.0.1",
@@ -52,5 +52,5 @@
52
52
  "url": "https://maxwellsimmer.com"
53
53
  }
54
54
  ],
55
- "gitHead": "63b04c68746dd40114a3718c6bef65710649a688"
55
+ "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
56
56
  }