@canopycanopycanopy/b-ber-grammar-spread 3.0.8-nav-memo.4 → 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-spread`
1
+ # b-ber-grammar-spread
2
2
 
3
- The `b-ber-grammar-spread` package renders b-ber's custom `spread` Markdown extension (directive) 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 `spread` / `exit` block directive pair for full-bleed spread containers. For `reader` and `web` builds the opening marker emits a two-level `<div>` scaffold (`<div ...><div id="..." class="spread__content">`) that allows CSS to position content edge-to-edge; for EPUB, Mobi, PDF, and sample builds it emits a plain `<section>`. The exit directive (handled by `b-ber-grammar-section`) closes the appropriate elements and, in reader builds, appends an empty `<div>` required as a spread marker. Uses `b-ber-parser-gallery` as the MarkdownIt plugin and delegates open/close validation to `b-ber-grammar-renderer`.
4
4
 
5
- ## Install
5
+ ## Usage
6
6
 
7
+ Registered as a MarkdownIt plugin by the rendering engine:
8
+
9
+ ```js
10
+ import spread from '@canopycanopycanopy/b-ber-grammar-spread'
11
+ // { plugin, name: 'spread', renderer }
7
12
  ```
8
- $ npm i -g @canopycanopycanopy/b-ber-grammar-spread
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-spread",
3
- "version": "3.0.8-nav-memo.4+d47a9aae",
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.4+d47a9aae",
29
- "@canopycanopycanopy/b-ber-grammar-renderer": "3.0.8-nav-memo.4+d47a9aae",
30
- "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.4+d47a9aae",
31
- "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.4+d47a9aae",
32
- "@canopycanopycanopy/b-ber-parser-gallery": "3.0.8-nav-memo.4+d47a9aae",
28
+ "@canopycanopycanopy/b-ber-grammar-attributes": "3.0.8-next.61+2bbec564",
29
+ "@canopycanopycanopy/b-ber-grammar-renderer": "3.0.8-next.61+2bbec564",
30
+ "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
31
+ "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
32
+ "@canopycanopycanopy/b-ber-parser-gallery": "3.0.8-next.61+2bbec564",
33
33
  "lodash": "^4.17.21",
34
34
  "tar": "^6.1.11"
35
35
  },
@@ -50,5 +50,5 @@
50
50
  "url": "https://maxwellsimmer.com"
51
51
  }
52
52
  ],
53
- "gitHead": "d47a9aae74dec3e3225e363b2434c7abe0fcf21b"
53
+ "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
54
54
  }