@canopycanopycanopy/b-ber-grammar-logo 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-logo`
1
+ # b-ber-grammar-logo
2
2
 
3
- The `b-ber-grammar-logo` package renders b-ber's custom `logo` 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 `logo` inline directive. Emits a `<figure class="logo">` containing an `<img>` element with a fixed inline width of 120px. Requires a `source` attribute pointing to an image file in the project's `_images` directory; warns (but does not abort) if the file does not exist. The source path is converted to a relative `../images/` URL in the output HTML. 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 logo from '@canopycanopycanopy/b-ber-grammar-logo'
11
+ // { plugin, name: 'logo', renderer }
7
12
  ```
8
- $ npm i -g @canopycanopycanopy/b-ber-grammar-logo
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-logo",
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
  "tar": "^6.1.11"
@@ -51,5 +51,5 @@
51
51
  "url": "https://maxwellsimmer.com"
52
52
  }
53
53
  ],
54
- "gitHead": "63b04c68746dd40114a3718c6bef65710649a688"
54
+ "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
55
55
  }