documentary - npm Package Compare versions

Comparing version 1.6.1 to 1.7.0

build/lib/replace-stream.js

@@ -26,2 +26,4 @@ "use strict";
 
+var _gif = _interopRequireDefault(require("./rules/gif"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -54,3 +56,3 @@
   });
-  const s = new _restream.Replaceable([cutInnerCode, cutTable, cutMethodTitle, cutCode, _rules.commentRule, _rules.badgeRule, _tree.default, _example.default, _fork.default, tocRule, insertTable, _table.default, {
+  const s = new _restream.Replaceable([cutInnerCode, cutTable, cutMethodTitle, cutCode, _rules.commentRule, _rules.badgeRule, _tree.default, _example.default, _fork.default, tocRule, _gif.default, insertTable, _table.default, {
     re: _rules.linkTitleRe,
@@ -57,0 +59,0 @@

CHANGELOG.md

@@ -0,1 +1,7 @@
+## 24 June 2018
+
+### 1.7.0
+
+- [feat] Gif detail replacements.
+
 ## 22 June 2018
@@ -2,0 +8,0 @@

package.json

 {
   "name": "documentary",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "A library to manage documentation, such as README, usage, man pages and changelog.",
@@ -19,3 +19,3 @@ "main": "build",
     "example/toc.js": "NODE_DEBUG=doc yarn e example/toc.js",
-    "build-src": "babel src --out-dir build --source-maps --ignore src/bin/register.js",
+    "build-src": "b --source-maps --ignore src/bin/register.js",
     "build": "yarn-s build-src doc"
@@ -44,9 +44,2 @@ },
   "devDependencies": {
-    "@babel/cli": "7.0.0-beta.51",
-    "@babel/core": "7.0.0-beta.51",
-    "@babel/plugin-syntax-object-rest-spread": "7.0.0-beta.51",
-    "@babel/plugin-transform-modules-commonjs": "7.0.0-beta.51",
-    "@babel/register": "7.0.0-beta.51",
-    "babel-plugin-transform-rename-import": "2.2.0",
-    "eslint": "4.19.1",
     "eslint-config-artdeco": "1.0.0",
@@ -53,0 +46,0 @@ "snapshot-context": "2.0.1",

README.md

@@ -32,2 +32,4 @@ # documentary
   * [Examples Placement](#examples-placement)
+  * [Gif Detail](#gif-detail)
+    * [<code>yarn doc</code>](#codeyarn-doccode)
 - [CLI](#cli)
@@ -179,2 +181,3 @@ - [API](#api)
 │   ├── 7-examples.md
+│   ├── 8-gif.md
 │   └── index.md
@@ -244,2 +247,35 @@ ├── 3-cli.md
 ````
+### Gif Detail
+
+The `GIF` rule will inserts a gif animation inside of a `<detail>` block. To highlight the summary with background color, `<code>` should be used instead of back-ticks. [TOC title link](##toc-titles) also work inside the summary.
+
+```
+%GIF doc/doc.gif
+Alt: Generating documentation.
+Click to View: [<code>yarn doc</code>](t)
+%
+```
+
+<details>
+  <summary>Click to View: <a name="codeyarn-doccode"><code>yarn doc</code></a></summary>
+  <table>
+  <tr><td>
+    <img alt="Alt: Generating documentation." src="doc/doc.gif" />
+  </td></tr>
+  </table>
+</details>
+<br>
+
+The actual html placed in the `README` looks like the one below:
+
+```html
+<details>
+  <summary>Summary of the detail: <code>yarn doc</code></summary>
+  <table>
+  <tr><td>
+    <img alt="Alt: Generating documentation." src="doc/doc.gif" />
+  </td></tr>
+  </table>
+</details>
+```
 ## CLI
@@ -246,0 +282,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

77298

increased by3.61%

Dev dependency count

4

decreased by-63.64%

Number of package files

32

increased by6.67%

Lines of code

744

increased by4.94%

Number of lines in readme file

345

increased by11.65%

No dependency changes