Update docs (#12)

* Update docs

* Update tags.js

* Update README.md

* Fix test passing, add ignore lock

* Add .travis.yml

* increase complext test time

Author: leoj3n

.gitignore

@@ -1,2 +1,3 @@
+package-lock.json
 node_modules/
 test/temp/

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js: node
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

README.md

@@ -1 +1,3 @@
 # bit-docs-tag-demo
+
+Adds a @demo that can point at an iframe.

bit-docs.js

@@ -1,14 +1,22 @@
 var tags = require("./tags");
 
 /**
- * @module {function} bit-docs-tag-demo
  * @parent plugins
+ * @module {function} bit-docs-tag-demo
+ * @group bit-docs-tag-demo/tags tags
  *
  * @description Provides an `@demo` tag for embedding HTML, CSS, and JS in an iframe.
  *
  * @body
  *
- * TBD
+ * This plugin registers onto these hooks:
+ *   - `tags`
+ *   - `html`
+ *
+ * Registering the `tags` hook adds the [bit-docs-tag-demo/tags/demo] tag.
+ * 
+ * Registering the `html` hook adds a static JavaScript file used to create
+ * the tabbed demo widget [bit-docs-tag-demo/demo].
  */
 module.exports = function(bitDocs){
 	var pkg = require("./package.json");
@@ -17,7 +25,10 @@ module.exports = function(bitDocs){
 	deps[pkg.name] = pkg.version;
 
 	bitDocs.register("html", {
-		dependencies: deps
+		dependencies: deps,
+        staticDist: [
+           path.join(__dirname, "test", "demos")
+        ]
 	});
 
 	bitDocs.register("tags", tags);

package.json

@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "bit-docs-generate-html": "0.5.0-pre.4",
-    "can-stache": "3.0.20",
+    "can-stache": "3.7.2",
     "express": "^4.15.2",
     "mocha": "^3.2.0",
     "rimraf": "^2.6.1",

tags.js

@@ -1,4 +1,63 @@
-
+/**
+ * @parent bit-docs-tag-demo/tags
+ * @module {bit-docs-process-tags/types/tag} bit-docs-tag-demo/tags/demo @demo
+ * 
+ * @description Placeholder for an application demo.
+ * 
+ * @signature `@demo PATH [HEIGHT]`
+ * 
+ * @codestart javascript
+ * /**
+ *  * @demo demos/example.html 300
+ *  *|
+ * @codeend
+ * 
+ * @param {String} PATH The path to a `.html` file.
+ * 
+ * @param {Number} [HEIGHT] The height of the html page. If a height is not
+ * provided, the height is determined as the content of the body.
+ * 
+ * @body
+ * 
+ * ## Specifying the HTML and JS source
+ * 
+ * By default, `@demo` uses the html of the body minus any script tags as the
+ * HTML source. This can be changed by:
+ * 
+ *  - Adding an element with `id="demo-html"` or 
+ *    setting `window.DEMO_HTML` to the source text.
+ *  - Adding `id="demo-source"` to a script tag or
+ *    setting `window.DEMO_SOURCE` to the source JS.
+ * 
+ * ### Example
+ * 
+ * An example demo file might look like:
+ * 
+ * ```html
+ * <div id="demo-html"><b>Hello world!</b></div>
+ * <script id="demo-source">
+ *   var div = document.createElement("div");
+ *   div.textContent = "it worked!";
+ *   document.body.appendChild(div);
+ * </script>
+ * ```
+ * 
+ * That gets used like:
+ * 
+ * ```js
+ * @@demo demos/example.html
+ * ```
+ * 
+ * Which gets translated to:
+ * 
+ * ```html
+ * @demo demos/example.html
+ * ```
+ * 
+ * And renders like:
+ * 
+ * @demo demos/example.html
+ */
 exports.demo = {
 	add: function(  line, curData, scope, objects, currentWrite ) {
 		var m = line.match(/^\s*@demo\s*([\w\.\/\-\$]*)\s*([\w]*)/)

test.js

@@ -252,7 +252,7 @@ describe('bit-docs-tag-demo', function () {
 		});
 
 		describe('complex', function () {
-			this.timeout(4000);
+			this.timeout(8000);
 
 			before(function () {
 				return browser.visit('/test/temp/complex.html');