Merge pull request #7 from bit-docs/docs

Update docs

Author: leoj3n

.gitignore

@@ -1,2 +1,3 @@
+package-lock.json
 node_modules/
 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"

bit-docs.js

@@ -1,14 +1,24 @@
 var tags = require("./tags");
 
 /**
- * @module {function} bit-docs-html-highlight-line
  * @parent plugins
+ * @module {function} bit-docs-html-highlight-line
+ * @group bit-docs-html-highlight-line/tags tags
+ * @group bit-docs-html-highlight-line/static static
  *
- * @description Adds a `@highlight` tag.  Needs to be used after `bit-docs-prettify`.
+ * @description Adds a `@highlight` tag. Needs to be used after [bit-docs-prettify].
  *
  * @body
  *
- * TBD
+ * This plugin registers onto these hooks:
+ *   - `tags`
+ *   - `html`
+ * 
+ * Registering the `tags` hook adds the
+ * [bit-docs-html-highlight-line/tags/highlight] tag.
+ * 
+ * Registering the `html` hook adds a static JavaScript file used to do the
+ * highlighting [bit-docs-html-highlight-line/highlight-line.js].
  */
 module.exports = function(bitDocs){
 	var pkg = require("./package.json");

highlight-line.js

@@ -28,6 +28,25 @@ var getLines = function(lineString) {
 	return result;
 };
 
+/**
+ * @parent bit-docs-html-highlight-line/static
+ * @module {function} bit-docs-html-highlight-line/highlight-line.js
+ * 
+ * Main front end JavaScript file for static portion of this plugin.
+ * 
+ * @signature `addHighlights()`
+ * 
+ * Goes through the lines in a `<code>` block and highlights the specified
+ * ranges. 
+ * 
+ * Finds all `<span highlight-line="..."></span>` elements and uses those as
+ * directives for what to highlight.
+ * 
+ * If the `only` option was specified to the
+ * [bit-docs-html-highlight-line/tags/highlight] tag, then non-highlighted
+ * lines will be collapsed if they exist greater than three lines away from a
+ * highlighted line.
+ */
 function addHighlights() {
 
 	$('span[line-highlight]').each(function(i, el) {

tags.js

@@ -1,3 +1,39 @@
+/**
+ * @parent bit-docs-html-highlight-line/tags
+ * @module {bit-docs-process-tags/types/tag} bit-docs-html-highlight-line/tags/highlight @highlight
+ * 
+ * Highlight the specified code lines.
+ * 
+ * @signature `@highlight LINES[,ONLY]`
+ * 
+ * @param {String} LINES The lines to highlight like `2-4`.
+ * 
+ * @param {String} [,ONLY] Collapse non-highlighted lines greater than three
+ * lines away (useful for long code snippets).
+ * 
+ * @codestart javascript
+ * /**
+ *  * ```js
+ *  * {
+ *  *   "name": "bit-docs",
+ *  *   "description": "Documentation generator",
+ *  *   "author": "Bitovi",
+ *  *   "license": "MIT",
+ *  *   "date": "2017",
+ *  *   "location": "Chicago",
+ *  *   "season": "Summer",
+ *  *   "awesome": "yes"
+ *  * }
+ *  * ``` 
+ *  *
+ *  * @highlight 2-4,only
+ *  *|
+ * @codeend
+ * 
+ * Injects a `<span line-highlight="2-4,only"></span>` element to the page that
+ * will be picked up and used by the static front-end script
+ * [bit-docs-html-highlight-line/highlight-line.js].
+ */
 exports.highlight = {
     add: function(line, curData) {
         var lines = line.replace("@highlight","").trim();