Merge pull request #11 from bit-docs/docs

Update docs

Author: justinbmeyer

.gitignore

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

bit-docs.js

@@ -1,12 +1,18 @@
 /**
- * @module {function} bit-docs-prettify
  * @parent plugins
+ * @module {function} bit-docs-prettify
+ * @group bit-docs-prettify/static static
  *
  * @description A bit-docs plugin that makes source-code snippets in HTML prettier.
- *
+ * 
  * @body
- *
- * TBD
+ * 
+ * This plugin registers onto the `html` hook.
+ * 
+ * Registering the `html` hook adds a static JavaScript file
+ * [bit-docs-prettify/prettify.js] that will go through every `<code>` element
+ * on the page applying the
+ * [code prettifier](https://github.com/google/code-prettify).
  */
 module.exports = function(bitDocs){
     var pkg = require("./package.json");

prettify.js

@@ -1,6 +1,19 @@
 require("./prettify-engine");
 require("./prettify.less")
 
+/**
+ * @parent bit-docs-prettify/static
+ * @module {function} bit-docs-prettify/prettify.js
+ * 
+ * Main front end JavaScript file for static portion of this plugin.
+ * 
+ * @signature `prettyPrint()`
+ * 
+ * Finds all `<code>` elements on the page and adds the `prettyprint` class
+ * before executing the required pretty print engine.
+ * 
+ * Also requires [bit-docs-prettify/prettify.less].
+ */
 module.exports = function(){
     var codes = document.getElementsByTagName("code");
     for(var i = 0; i < codes.length; i ++){

prettify.less

@@ -4,17 +4,16 @@
 @import "locate://bit-docs-site/styles/variables.less";
 
 /**
- * @stylesheet prettify.less Prettify
- * @parent bit-docs/theme
+ * @parent bit-docs-prettify/static
+ * @module bit-docs-prettify/prettify.less
  *
- * @description
- * Layout of code wells and syntax highlighting of code languages. 
+ * @description Layout of code wells and syntax highlighting of code languages.
  *
  * @body
  *
  * Syntax highlighting and colors provided by 
- * <a href="https://github.com/google/code-prettify">prettify.js</a> and
- * <a href="https://github.com/chriskempson/tomorrow-theme">Tomorrow Theme</a>.
+ * [JavaScript code prettifier](https://github.com/google/code-prettify) and
+ * [Tomorrow Theme](https://github.com/chriskempson/tomorrow-theme).
  *
  * Code "wells" are styled based on the use of the `<pre>` and `<code>` tags
  * around your desired code example.
@@ -64,7 +63,6 @@
  * }
  * ```
  */
-
 code {
   padding: 0 5px;
   border-radius: 5px;