Initial commit

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,43 @@
+# nd
+
+_experimental and unreleased_
+
+_a documentation viewer for node.js_
+
+<img src="https://github.com/russfrank/nd/raw/master/shot.png" />
+
+*nd* is a documentation viewer for node.  Similar to 
+[mad(1)](http://tjholowaychuk.com/post/21100445420/going-mad-1),
+it displays markdown documents in your terminal.  Dissimilarly to *mad*, nd
+is written in javascript.  
+
+By writing this software in javascript, we benefit
+from the existing `require()` circuitry.  This means that most packages in
+`npm`, despite not having a `doc` directory full of markdown files, have some
+useful information available in *nd*.  Nearly every package at least has a
+`README.md`; *nd* will read this.
+
+If a `doc` or `docs` directory is present, or if there is a docs directory
+specified in the `package.json` of some module, documentation will be loaded
+out of these directories.  
+
+For example, if we type
+
+`nd npm cli`
+
+We will get `npm/doc/cli/index.md`. So, if additional arguments (besides the
+module name) are provided, we try to find a file which is more specific:
+we'll look for `module/arg1/arg2/index.md`, `module/arg1/arg2.md`, and
+`module/arg1/arg2.md`.  This allows us to be flexible about the organization
+of documentation within modules.
+
+## Future
+
+More ideas:
+
+1. Pydoc like web server
+2. Docco view of source files (markdown comments on left, source on right) in terminal
+
+## License
+
+MIT.

app.js

@@ -0,0 +1,67 @@
+var flatiron = require('flatiron');
+var path = require('path');
+var fs = require('fs');
+var _ = require('underscore');
+var app = flatiron.app;
+var find = require('./lib/find');
+var async = require('async');
+
+app.config.file({ file: path.join(__dirname, 'config', 'config.json') });
+
+app.use(flatiron.plugins.cli, {
+  source: path.join(__dirname, 'lib', 'commands'),
+  usage: 'Empty Flatiron Application, please fill out commands',
+  argv: {
+    l: {
+      description: 'list',
+      boolean: true
+    }
+  }
+});
+
+function list (path) {
+  try {
+    var contents = fs.readdirSync(path);
+    console.dir(contents);
+  } catch (e) {
+    app.log.error("directory not found");
+  }
+}
+
+function view (module, args) {
+  async.waterfall([
+    function (callback)       { find.root(module, callback); },
+    function (root, callback) { find.docDir(root, callback); },
+    function (dirs, callback) { find.file(dirs, args, module, callback); }
+  ], function (err, data) {
+    if (err) {
+      app.log.error(err);
+      return;
+    }
+
+    var marked = require('./deps/marked').setOptions({gfm: true, terminal: true});
+    var moar = require('moar');
+
+    moar.write('\n' + marked.parse(data));
+    moar.end();
+  });
+}
+
+app.init(function (err) {
+  if (err) return app.log.error(err);
+
+  var args = app.argv._;
+  var module = args.shift();
+
+  if (app.argv.l) {
+    // list mode
+  } else {
+    // view
+    if (!module) {
+      app.log.error('you must specify a module name, like this');
+      app.log.info('nd [modulename]');
+    } else {
+      view(module, args);
+    }
+  }
+});

bin/nd

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../app.js');

config/config.json

@@ -0,0 +1,2 @@
+{
+}

deps/marked/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011-2012, Christopher Jeffrey (https://github.com/chjj/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

deps/marked/Makefile

@@ -0,0 +1,9 @@
+all:
+	@cp lib/marked.js marked.js
+	@uglifyjs -o marked.min.js marked.js
+
+clean:
+	@rm marked.js
+	@rm marked.min.js
+
+.PHONY: clean all

deps/marked/README.md

@@ -0,0 +1,125 @@
+# marked
+
+A full-featured markdown parser and compiler, written in javascript.
+Built for speed.
+
+## Benchmarks
+
+node v0.4.x
+
+``` bash
+$ node test --bench
+marked completed in 12071ms.
+showdown (reuse converter) completed in 27387ms.
+showdown (new converter) completed in 75617ms.
+markdown-js completed in 70069ms.
+```
+
+node v0.6.x
+
+``` bash
+$ node test --bench
+marked completed in 6448ms.
+marked (gfm) completed in 7357ms.
+marked (pedantic) completed in 6092ms.
+discount completed in 7314ms.
+showdown (reuse converter) completed in 16018ms.
+showdown (new converter) completed in 18234ms.
+markdown-js completed in 24270ms.
+```
+
+__Marked is now faster than Discount, which is written in C.__
+
+For those feeling skeptical: These benchmarks run the entire markdown test suite
+1000 times. The test suite tests every feature. It doesn't cater to specific
+aspects.
+
+## Install
+
+``` bash
+$ npm install marked
+```
+
+## Another Javascript Markdown Parser
+
+The point of marked was to create a markdown compiler where it was possible to
+frequently parse huge chunks of markdown without having to worry about
+caching the compiled output somehow...or blocking for an unnecesarily long time.
+
+marked is very concise and still implements all markdown features. It is also
+now fully compatible with the client-side.
+
+marked more or less passes the official markdown test suite in its
+entirety. This is important because a surprising number of markdown compilers
+cannot pass more than a few tests. It was very difficult to get marked as
+compliant as it is. It could have cut corners in several areas for the sake
+of performance, but did not in order to be exactly what you expect in terms
+of a markdown rendering. In fact, this is why marked could be considered at a
+disadvantage in the benchmarks above.
+
+Along with implementing every markdown feature, marked also implements
+[GFM features](http://github.github.com/github-flavored-markdown/).
+
+## Options
+
+marked has 4 different switches which change behavior.
+
+- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.
+  Don't fix any of the original markdown bugs or poor behavior.
+- __gfm__: Enable github flavored markdown (enabled by default).
+- __sanitize__: Sanitize the output. Ignore any HTML that has been input.
+- __highlight__: A callback to highlight code blocks.
+
+None of the above are mutually exclusive/inclusive.
+
+## Usage
+
+``` js
+// Set default options
+marked.setOptions({
+  gfm: true,
+  pedantic: false,
+  sanitize: true,
+  // callback for code highlighter
+  highlight: function(code, lang) {
+    if (lang === 'js') {
+      return javascriptHighlighter(code);
+    }
+    return code;
+  }
+});
+console.log(marked('i am using __markdown__.'));
+```
+
+You also have direct access to the lexer and parser if you so desire.
+
+``` js
+var tokens = marked.lexer(text);
+console.log(marked.parser(tokens));
+```
+
+``` bash
+$ node
+> require('marked').lexer('> i am using marked.')
+[ { type: 'blockquote_start' },
+  { type: 'paragraph',
+    text: 'i am using marked.' },
+  { type: 'blockquote_end' },
+  links: {} ]
+```
+
+## CLI
+
+``` bash
+$ marked -o hello.html
+hello world
+^D
+$ cat hello.html
+<p>hello world</p>
+```
+
+## License
+
+Copyright (c) 2011-2012, Christopher Jeffrey. (MIT License)
+
+See LICENSE for more info.