New layout structure, other docs

Author: leoj3n

bit-docs.js

@@ -11,20 +11,21 @@ var mergeOnto = function(prop, dest, source){
 /**
  * @parent plugins
  * @module {function} bit-docs-generate-html
- * @group bit-docs-generate-html/theme theme
  * @group bit-docs-generate-html/modules modules
+ * @group bit-docs-generate-html/static static
+ * @group bit-docs-generate-html/templates templates
+ * @group bit-docs-generate-html/types types
  *
  * @description Generates HTML for a docMap.  Supports plugins.
  *
  * @body
  *
  * TBD
  */
-
 module.exports = function(bitDocs){
     bitDocs.register("generator", generator);
 
-	bitDocs.register("tags", tags);
+    bitDocs.register("tags", tags);
 
     bitDocs.handle("html", function(siteConfig, htmlConfig) {
         if(!siteConfig.html) {
@@ -39,5 +40,5 @@ module.exports = function(bitDocs){
 
         mergeOnto("static", html, htmlConfig);
         mergeOnto("templates", html, htmlConfig);
-	});
+    });
 };

build/helpers.js

@@ -8,7 +8,7 @@ var buildHash = require("./build_hash");
 
 /**
  * @parent bit-docs-generate-html/modules
- * @module {Promise} bit-docs-generate-html/build/helpers
+ * @module {Promise} bit-docs-generate-html/build/helpers helpers
  *
  * Gets the default helpers, and helpers in the _{buildHash}/site/templates_
  * folder, and registers them with Handlebars.
@@ -17,7 +17,6 @@ var buildHash = require("./build_hash");
  *
  * Registers helpers
  *
- *
  * @param {Promise<Handlebars>} buildTemplatesPromise The result of calling
  * [bit-docs-generate-html/build/templates]. Building the helpers must happen
  * after the templates have been copied over. Passing this argument enforces

build/renderer.js

@@ -8,7 +8,7 @@ var buildHash = require("./build_hash");
 
 /**
  * @parent bit-docs-generate-html/modules
- * @module {function} bit-docs-generate-html/build/renderer
+ * @module {function} bit-docs-generate-html/build/renderer renderer
  *
  * Creates a renderer function used to generate
  * the documentation.

build/renderer.md

@@ -1,21 +1,18 @@
-@typedef {function(documentjs.process.docObject)} documentjs.generators.html.types.renderer(docObject) renderer
-@parent documentjs.generators.html.build.types
+@parent bit-docs-generate-html/types
+@typedef {function(bit-docs/types/docObject)} bit-docs-generate-html/types/renderer(docObject) renderer
 
-A renderer built by [documentjs.generators.html.build.renderer] that is used to
-render each [documentjs.process.docObject docObject].  
+A renderer built by [bit-docs-generate-html/build/renderer] that is used to
+render each [bit-docs/types/docObject].
 
-@param {documentjs.process.docObject} docObject The [documentjs.tags tag] data
-of a comment.
+@param {bit-docs/types/docObject} docObject The
+[bit-docs/types/tagCollection] data of a comment.
 
 @return {String} The HTML to be outputted.
 
 @body
 
 ## Properties
 
-A renderer function also has a `.layout` property which can be used
-to render the layout template and a `.content` property that can be used
-to render the `content` template.
-
-
-
+A renderer function also has a `.layout` property which can be used to render
+the `layout` template and a `.content` property that can be used to render
+the `content` template.

build/static_dist.js

@@ -1,53 +1,53 @@
-var fss = require('../fs_extras.js'),
-	Q = require('q'),
-	path = require('path'),
-	md5 = require('md5'),
-	promiseLock = require("../promise_lock"),
-	npm = require("enpeem"),
-	fs = require("fs-extra"),
-	_ = require("lodash");
-
-var queue = promiseLock(),
-	buildHash = require("./build_hash"),
-	remove = Q.denodeify(fs.remove);
+var fss = require('../fs_extras.js');
+var Q = require('q');
+var path = require('path');
+var md5 = require('md5');
+var promiseLock = require("../promise_lock");
+var npm = require("enpeem");
+var fs = require("fs-extra");
+var _ = require("lodash");
+
+var queue = promiseLock();
+var buildHash = require("./build_hash");
+var remove = Q.denodeify(fs.remove);
 
 /**
  * @parent bit-docs-generate-html/modules
- * @module {function} bit-docs-generate-html/build/static_dist
+ * @module {function} bit-docs-generate-html/build/static_dist staticDist
  *
- * Builds a static distributable which will eventually be copied
- * to the `static` folder of the generated output.
+ * Builds a static distributable which will eventually be copied to the
+ * `static` folder of the generated output.
  *
  * @signature `.build.staticDist(options)`
  *
  * Builds the static distributable with the following steps:
  *
- * 1. Copies everything from _documentjs/site/default/static_ to
- *    _documentjs/site/static/build_.
- * 2. Copies the path in `options.dest` to _documentjs/site/static/build_.
- * 3. `require`s the module at _documentjs/site/static/build/build.js_.
- * 4. Calls that "build" module function with the options and returns the result.
+ * 1. Copies everything from _site/default/static_ to _site/static/build_.
+ * 2. Copies the path in `options.dest` to _site/static/build_.
+ * 3. `require`s the module at _site/static/build/build.js_.
+ * 4. Calls that "build" module function with the options and returns the
+ * result.
  *
- * The "build" module is expected to build a minified distributable
- * and copy the necessary contents to _documentjs/site/static/dist_ and
- * return a promise that resolves when complete.
+ * The "build" module is expected to build a minified distributable and copy
+ * the necessary contents to _site/static/dist_ and return a promise that
+ * resolves when complete.
  *
  * @param {{}} options
  *
- * @option {Boolean} [forceBuild=false] If set to `true`, rebuilds the
- * static bundle even if it has already been built.
+ *   @option {Boolean} [forceBuild=false] If set to `true`, rebuilds the static
+ *   bundle even if it has already been built.
+ *   
+ *   @option {String} dest The final destination ouput of the static
+ *   distributable.
  *
- * @option {String} dest The final destination ouput of the static
- * distributable.
- *
- * @option {String} static The location of static content used to overwrite or
- * add to the default static content.
- *
- * @option {Boolean} [minifyBuild=true] If set to `false` the build will not
- * be minified. This behavior should be implemented by the "build" module.
- *
- * @return {Promise} A promise that resolves if the static dist was successfully created.
+ *   @option {String} static The location of static content used to overwrite or
+ *   add to the default static content.
+ *   
+ *   @option {Boolean} [minifyBuild=true] If set to `false` the build will not be
+ *   minified. This behavior should be implemented by the "build" module.
  *
+ * @return {Promise} A promise that resolves if the static dist was
+ * successfully created.
  */
 module.exports = function(options){
 	// only run one build at a time.
@@ -56,8 +56,8 @@ module.exports = function(options){
 
 		var hash = buildHash(options);
 
-		var distFolder = path.join("site","static","dist", hash),
-			buildFolder = path.join("site","static","build", hash);
+		var distFolder = path.join("site","static","dist", hash);
+		var buildFolder = path.join("site","static","build", hash);
 
 		var mkdirPromise = Q.all([
 			fss.mkdirs(distFolder),
@@ -103,8 +103,8 @@ module.exports = function(options){
 
 };
 
-var readFile = Q.denodeify(fs.readFile),
-	writeFile = Q.denodeify(fs.writeFile);
+var readFile = Q.denodeify(fs.readFile);
+var writeFile = Q.denodeify(fs.writeFile);
 
 function addPackages(siteConfig, buildFolder) {
 	if(siteConfig.html && siteConfig.html.dependencies) {
@@ -167,7 +167,6 @@ function installPackages(options, buildFolder, distFolder, hash){
 	});
 }
 
-
 function callIfFunction(value){
   if(typeof value === "function") {
 	value();

site/default/default.md

@@ -1,5 +1,5 @@
-@parent bit-docs-generate-html/theme
-@page bit-docs-generate-html/theme/about About the Default Theme
+@parent bit-docs-generate-html
+@page bit-docs-generate-html/about About
 
 @description Templates and styles come with the default theme.
 
@@ -29,7 +29,7 @@ structure purposes, in tandem with [bit-docs-generate-html/theme/styles].
 
 For any template files not copied over, the default template will be used.
 
-### Styles
+### Static
 
 Styles are used to modify the visual representation of a generated website.
 

site/default/static/styles/mixins.less

@@ -1,6 +1,6 @@
 /**
- * @parent bit-docs-generate-html/theme
- * @module bit-docs-generate-html/site/default/static/styles/mixins.less mixins.less
+ * @parent bit-docs-generate-html/static
+ * @module bit-docs-generate-html/site/default/styles/mixins.less mixins.less
  *
  * @description Mixins for site-wide visual layout.
  *

site/default/static/styles/styles.less

@@ -1,5 +1,5 @@
 /**
- * @parent bit-docs-generate-html/theme
+ * @parent bit-docs-generate-html/static
  * @module bit-docs-generate-html/site/default/static/styles/styles.less styles.less
  *
  * @description The primary styles for the default theme.

site/default/static/styles/variables.less

@@ -1,5 +1,5 @@
 /**
- * @parent bit-docs-generate-html/theme
+ * @parent bit-docs-generate-html/static
  * @module bit-docs-generate-html/site/default/static/styles/variables.less variables.less
  *
  * @description Variables to hold site-wide visual configurations.

site/default/templates/body.mustache.md

@@ -1,5 +1,5 @@
-@parent bit-docs-generate-html/theme
-@module bit-docs-generate-html/site/default/templates/body.mustache body.mustache
+@parent bit-docs-generate-html/templates
+@page bit-docs-generate-html/site/default/templates/body.mustache body.mustache
 
 @description The default body template.