Merge branch 'edge'

Author: neogeek

CHANGELOG.md

@@ -1,5 +1,10 @@
 #Changelog
 
+##0.0.2 (August 7, 2014)
+
+- Added output flag.
+- Added syntax highlighting to Bootstrap layout.
+
 ##0.0.1 (August 3, 2014)
 
 - Initial public release.

README.md

@@ -1,4 +1,4 @@
-[![](https://david-dm.org/neogeek/doxdox.svg)](https://david-dm.org/neogeek/doxdox/)
+[![](https://david-dm.org/neogeek/doxdox.svg)](https://david-dm.org/neogeek/doxdox/) [![](http://img.shields.io/npm/v/doxdox.svg)](https://www.npmjs.org/package/doxdox)
 
 #doxdox
 
@@ -24,6 +24,7 @@ $ npm install doxdox -g
  -t, --title        Sets title.
  -d, --description  Sets description.
  -l, --layout       Template to render the documentation with.
+ -o, --output       File to save documentation to. Default to stdout.
 
  Available Layouts:
 

bin/doxdox

@@ -2,6 +2,7 @@
 
 var pkg = require('../package'),
     fs = require('fs'),
+    chalk = require('chalk'),
     dox = require('dox'),
     hbs = require('handlebars'),
     helpers = require('../lib/helpers')(hbs),
@@ -15,14 +16,15 @@ var templates = {
 var title = 'Untitled Project',
     description = '',
     layout = 'bootstrap',
-    filename = '';
+    script = '',
+    output = '';
 
 var args = process.argv.slice(2),
     value;
 
 if (args.length && !args[0].match(/^\-/)) {
 
-    filename = args.shift();
+    script = args.shift();
 
 }
 
@@ -47,6 +49,11 @@ while (args.length) {
         layout = args.shift();
         break;
 
+    case '-o':
+    case '--output':
+        output = args.shift();
+        break;
+
     case '-v':
     case '--version':
         process.stdout.write(pkg.version + '\n');
@@ -55,17 +62,19 @@ while (args.length) {
 
     default:
         process.stdout.write('\n');
-        process.stdout.write(' Usage: doxdox <file> [options]' + '\n\n');
+        process.stdout.write(chalk.blue(' Usage:') + ' doxdox <file> [options]' + '\n\n');
         process.stdout.write(' Options:' + '\n\n');
-        process.stdout.write(' -h, --help\t\tDisplay this help message.' + '\n');
-        process.stdout.write(' -v, --version\t\tDisplay the current installed version.' + '\n');
-        process.stdout.write(' -t, --title\t\tSets title.' + '\n');
-        process.stdout.write(' -d, --description\tSets description.' + '\n');
-        process.stdout.write(' -l, --layout\t\tTemplate to render the documentation with.' + '\n');
+        process.stdout.write(chalk.yellow('  -h, --help') + '\t\tDisplay this help message.' + '\n');
+        process.stdout.write(chalk.yellow('  -v, --version') + '\t\tDisplay the current installed version.' + '\n');
+        process.stdout.write(chalk.yellow('  -t, --title') + '\t\tSets title.' + '\n');
+        process.stdout.write(chalk.yellow('  -d, --description') + '\tSets description.' + '\n');
+        process.stdout.write(chalk.yellow('  -l, --layout') + '\t\tTemplate to render the documentation with.' + '\n');
+        process.stdout.write(chalk.yellow('  -l, --layout') + '\t\tTemplate to render the documentation with.' + '\n');
+        process.stdout.write(chalk.yellow('  -o, --output') + '\t\tFile to save documentation to. Default to stdout.' + '\n');
         process.stdout.write('\n');
         process.stdout.write(' Available Layouts:' + '\n\n');
-        process.stdout.write(' - Bootstrap (default)\t\t(http://getbootstrap.com/)' + '\n');
-        process.stdout.write(' - Markdown\t\t\t(http://daringfireball.net/projects/markdown/)' + '\n');
+        process.stdout.write('  - Bootstrap (default)\t  (http://getbootstrap.com/)' + '\n');
+        process.stdout.write('  - Markdown\t\t  (http://daringfireball.net/projects/markdown/)' + '\n');
         process.stdout.write('\n');
         process.kill();
         break;
@@ -74,21 +83,32 @@ while (args.length) {
 
 }
 
-fs.exists(filename, function (exists) {
+fs.exists(script, function (exists) {
 
-    var data;
+    var content,
+        data;
 
     if (exists) {
 
-        data = dox.parseComments(fs.readFileSync(filename, 'utf8'));
+        data = dox.parseComments(fs.readFileSync(script, 'utf8'));
 
         if (templates[layout]) {
 
-            process.stdout.write(templates[layout]({
+            content = templates[layout]({
                 title: title,
                 description: description,
                 methods: utils.parseData(data)
-            }));
+            });
+
+            if (output) {
+
+                fs.writeFileSync(output, content, 'utf8');
+
+            } else {
+
+                process.stdout.write(content);
+
+            }
 
         } else {
 

package.json

@@ -1,10 +1,11 @@
 {
     "name": "doxdox",
     "description": "HTML and Markdown documentation generator.",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "bin": "./bin/doxdox",
     "license": "MIT",
     "dependencies": {
+        "chalk": "0.5.1",
         "dox": "0.4.6",
         "handlebars": "1.3.0"
     },

templates/bootstrap.hbs

@@ -29,27 +29,14 @@
     text-align: center;
 }
 
+pre .hljs {
+    padding: 0;
+    background: none;
+}
+
 </style>
 <script>
-
-(function () {
-
-    'use strict';
-
-    var css = document.createElement('link'),
-        protocol = window.location.protocol;
-
-    if (protocol === 'file:') {
-        protocol = 'http:';
-    }
-
-    css.setAttribute('rel', 'stylesheet');
-    css.setAttribute('href', protocol + '//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css');
-
-    document.head.appendChild(css);
-
-}());
-
+(function(e,t,i){"use strict";var s=e.location.protocol==="file:"?"http:":e.location.protocol,c=["//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css","//cdn.jsdelivr.net/highlight.js/8.0/styles/github.css","//cdn.jsdelivr.net/highlight.js/8.0/highlight.min.js","//cdn.jsdelivr.net/jquery/2.1.1/jquery.min.js"];c.forEach(function(e){var o;if(e.match(/\.js$/)){o=t.createElement("script");o.setAttribute("src",s+e)}else if(e.match(/\.css$/)){o=t.createElement("link");o.setAttribute("rel","stylesheet");o.setAttribute("href",s+e)}o.addEventListener("load",function(){if(this.hasAttribute("src")){c.splice(c.indexOf(this.getAttribute("src")),1)}else if(this.hasAttribute("href")){c.splice(c.indexOf(this.getAttribute("href")),1)}if(!c.length){if($.isReady){i()}else{$(document).ready(i)}}});t.head.appendChild(o)})})(window,document,function(){var e=window.location.hash,t=$('[id="'+e.replace(/#/,"")+'"]'),i=$(".code"),s=$(".scope-private"),c=$(".toggle-code-blocks");$toggle_private=$(".toggle-private");c.on("click",function(){if(c.is(":checked")){i.show()}else{i.hide()}});$toggle_private.on("click",function(){if($toggle_private.is(":checked")){s.show()}else{s.hide()}});i.hide();s.hide();if(t.length&&!t.is(":visible")){$toggle_private.trigger("click")}$(".examples pre code, .code pre code").each(function(){hljs.highlightBlock(this)})});
 </script>
 </head>
 
@@ -207,7 +194,7 @@
 
                                     <h3>Code</h3>
 
-                                    <pre>{{code}}</pre>
+                                    <pre><code>{{code}}</code></pre>
 
                                 </section>
 
@@ -249,50 +236,5 @@
 
 </footer>
 
-<script src="http://cdn.jsdelivr.net/jquery/2.1.1/jquery.min.js"></script>
-<script>
-
-(function () {
-
-    var hash = window.location.hash,
-        $hash_elem = $('[id="' + hash.replace(/#/, '') + '"]'),
-        $code_block = $('.code'),
-        $scope_private = $('.scope-private'),
-        $toggle_code_blocks = $('.toggle-code-blocks')
-        $toggle_private = $('.toggle-private');
-
-    $toggle_code_blocks.on('click', function () {
-
-        if ($toggle_code_blocks.is(':checked')) {
-            $code_block.show();
-        } else {
-            $code_block.hide();
-        }
-
-    });
-
-    $toggle_private.on('click', function () {
-
-        if ($toggle_private.is(':checked')) {
-            $scope_private.show();
-        } else {
-            $scope_private.hide();
-        }
-
-    });
-
-    $code_block.hide();
-    $scope_private.hide();
-
-    if ($hash_elem.length && !$hash_elem.is(':visible')) {
-
-        $toggle_private.trigger('click');
-
-    }
-
-}());
-
-</script>
-
 </body>
 </html>

templates/bootstrap.js

@@ -0,0 +1,104 @@
+(function (w, d, f) {
+
+    'use strict';
+
+    var protocol = w.location.protocol === 'file:' ? 'http:' : w.location.protocol,
+        resource = [
+            '//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css',
+            '//cdn.jsdelivr.net/highlight.js/8.0/styles/github.css',
+            '//cdn.jsdelivr.net/highlight.js/8.0/highlight.min.js',
+            '//cdn.jsdelivr.net/jquery/2.1.1/jquery.min.js'
+        ];
+
+    resource.forEach(function (url) {
+
+        var tag;
+
+        if (url.match(/\.js$/)) {
+
+            tag = d.createElement('script');
+            tag.setAttribute('src', protocol + url);
+
+        } else if (url.match(/\.css$/)) {
+
+            tag = d.createElement('link');
+            tag.setAttribute('rel', 'stylesheet');
+            tag.setAttribute('href', protocol + url);
+
+        }
+
+        tag.addEventListener('load', function () {
+
+            if (this.hasAttribute('src')) {
+
+                resource.splice(resource.indexOf(this.getAttribute('src')), 1);
+
+            } else if (this.hasAttribute('href')) {
+
+                resource.splice(resource.indexOf(this.getAttribute('href')), 1);
+
+            }
+
+            if (!resource.length) {
+
+                if ($.isReady) {
+
+                    f();
+
+                } else {
+
+                    $(document).ready(f);
+
+                }
+
+            }
+
+        });
+
+        d.head.appendChild(tag);
+
+    });
+
+}(window, document, function () {
+
+    var hash = window.location.hash,
+        $hash_elem = $('[id="' + hash.replace(/#/, '') + '"]'),
+        $code_block = $('.code'),
+        $scope_private = $('.scope-private'),
+        $toggle_code_blocks = $('.toggle-code-blocks')
+        $toggle_private = $('.toggle-private');
+
+    $toggle_code_blocks.on('click', function () {
+
+        if ($toggle_code_blocks.is(':checked')) {
+            $code_block.show();
+        } else {
+            $code_block.hide();
+        }
+
+    });
+
+    $toggle_private.on('click', function () {
+
+        if ($toggle_private.is(':checked')) {
+            $scope_private.show();
+        } else {
+            $scope_private.hide();
+        }
+
+    });
+
+    $code_block.hide();
+    $scope_private.hide();
+
+    if ($hash_elem.length && !$hash_elem.is(':visible')) {
+
+        $toggle_private.trigger('click');
+
+    }
+
+    $('.examples pre code, .code pre code').each(function() {
+        hljs.highlightBlock(this);
+    });
+
+}));