@emdaer/plugin-table - npm Package Compare versions

Comparing version 2.1.1 to 2.4.0

.emdaer/README.emdaer.md

 # <!--emdaer-p
   - '@emdaer/plugin-value-from-package'
   - value: name
+--> · <!--emdaer-p
+  - '@emdaer/plugin-shields'
+  - shields:
+      - alt: 'Travis'
+        image: 'travis/emdaer/emdaer.svg'
+        link: 'https://travis-ci.org/emdaer/emdaer/'
+        style: 'flat-square'
+      - alt: 'Documented with emdaer'
+        image: 'badge/📓-documented%20with%20emdaer-F06632.svg'
+        link: 'https://github.com/emdaer/emdaer'
+        style: 'flat-square'
+      - alt: 'Maintained with lerna'
+        image: 'badge/🐉-maintained%20with%20lerna-cc00ff.svg'
+        link: 'https://lernajs.io/'
+        style: 'flat-square'
 -->
@@ -11,3 +26,38 @@
 
+## Usage
+
 <!--emdaer-p
+   - '@emdaer/plugin-value-from-package'
+   - value: name
+--> is an [emdaer](https://github.com/emdaer/emdaer/) plugin – see the [emdaer monorepo](https://github.com/emdaer/emdaer/) for more information
+
+## Documentation
+
+### Example
+<!--emdaer-p
+  - '@emdaer/plugin-table'
+  - headers:
+    - Col 1
+    - Col 2
+    rows:
+    -
+      - Hello
+      - World!
+    -
+      - Hello
+      - World!
+-->
+
+### Usage in README
+
+```md
+<!--emdaer-p 
+  - '@emdaer/plugin-jsdoc-tag-value'
+  - source: ./src/index.js
+    functionName: tablePlugin
+    tag: example
+-->
+```
+
+<!--emdaer-p
   - '@emdaer/plugin-documentation'
@@ -14,0 +64,0 @@ - sources:

CHANGELOG.md

@@ -6,2 +6,14 @@ # Change Log
 
+<a name="2.4.0"></a>
+# [2.4.0](https://github.com/emdaer/emdaer/compare/v2.1.1...v2.4.0) (2018-04-29)
+
+
+### Features
+
+* **plugin-jsdoc-tag-value:** add plugin and self document ([13130cd](https://github.com/emdaer/emdaer/commit/13130cd))
+
+
+
+
+
 <a name="2.1.1"></a>
@@ -8,0 +20,0 @@ ## [2.1.1](https://github.com/emdaer/emdaer/compare/v2.1.0...v2.1.1) (2018-04-29)

lib/index.js

@@ -6,2 +6,16 @@ /*  */
  *
+ * @example
+ * <!--emdaer-p
+ *   - '@emdaer/plugin-table'
+ *   - headers:
+ *     - Col 1
+ *     - Col 2
+ *     rows:
+ *     -
+ *       - Hello
+ *       - World!
+ *     -
+ *       - Hello
+ *       - World!
+ * -->
  * @param options
@@ -8,0 +22,0 @@ * @param {Array<string>} [options.headers] The headers of the table

package.json

 {
   "name": "@emdaer/plugin-table",
   "description": "An emdaer plugin that renders HTML tables",
-  "version": "2.1.1",
+  "version": "2.4.0",
   "repository": "emdaer/emdaer",
@@ -6,0 +6,0 @@ "homepage": "https://emdaer.me/",

README.md

@@ -7,4 +7,27 @@ <!--
 
-<h1 id="-emdaer-plugin-table">@emdaer/plugin-table</h1>
+<h1 id="-emdaer-plugin-table-travis-documented-with-emdaer-maintained-with-lerna">@emdaer/plugin-table · <a href="https://travis-ci.org/emdaer/emdaer/"><img src="https://img.shields.io/travis/emdaer/emdaer.svg?style=flat-square" alt="Travis"></a> <a href="https://github.com/emdaer/emdaer"><img src="https://img.shields.io/badge/📓-documented%20with%20emdaer-F06632.svg?style=flat-square" alt="Documented with emdaer"></a> <a href="https://lernajs.io/"><img src="https://img.shields.io/badge/🐉-maintained%20with%20lerna-cc00ff.svg?style=flat-square" alt="Maintained with lerna"></a></h1>
 <p>An emdaer plugin that renders HTML tables</p>
+<h2 id="usage">Usage</h2>
+<p>@emdaer/plugin-table is an <a href="https://github.com/emdaer/emdaer/">emdaer</a> plugin – see the <a href="https://github.com/emdaer/emdaer/">emdaer monorepo</a> for more information</p>
+<h2 id="documentation">Documentation</h2>
+<h3 id="example">Example</h3>
+<table><tr><th>Col 1</th><th>Col 2</th></tr><tr><td>Hello</td><td>World!</td></tr><tr><td>Hello</td><td>World!</td></tr></table>
+
+<h3 id="usage-in-readme">Usage in README</h3>
+
+```md
+<!--emdaer-p
+  - '@emdaer/plugin-table'
+  - headers:
+    - Col 1
+    - Col 2
+    rows:
+    -
+      - Hello
+      - World!
+    -
+      - Hello
+      - World!
+-->
+```
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
@@ -21,2 +44,19 @@ <h2 id="tableplugin">tablePlugin</h2>
 </ul>
+<p><strong>Examples</strong></p>
+
+```javascript
+<!--emdaer-p
+  - '@emdaer/plugin-table'
+  - headers:
+    - Col 1
+    - Col 2
+    rows:
+    -
+      - Hello
+      - World!
+    -
+      - Hello
+      - World!
+-->
+```
 <p>Returns <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</strong> The HTML table element</p>

src/index.js

@@ -6,2 +6,16 @@ /* @flow */
  *
+ * @example
+ * <!--emdaer-p
+ *   - '@emdaer/plugin-table'
+ *   - headers:
+ *     - Col 1
+ *     - Col 2
+ *     rows:
+ *     -
+ *       - Hello
+ *       - World!
+ *     -
+ *       - Hello
+ *       - World!
+ * -->
  * @param options
@@ -8,0 +22,0 @@ * @param {Array<string>} [options.headers] The headers of the table

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Improved metrics

Total package byte prevSize

24812

14.79%

Lines of code

125

28.87%

Number of lines in readme file

61

190.48%

Worsened metrics

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes