Dox2md.

Author: rstacruz

Makefile

@@ -1,6 +1,6 @@
 UGLIFY := ./node_modules/.bin/uglifyjs --comments "/^!/"
 STYLUS := ./node_modules/.bin/stylus -U -u nib
-DOX := dox
+DOX := ./node_modules/.bin/dox
 
 all: \
 	flatdoc.js \
@@ -25,7 +25,7 @@ theme-white/script.js: theme-white/setup.js vendor/jquery.scrollagent.js vendor/
 	cat $^ > $@
 
 Reference.md: src/flatdoc.js
-	$(DOX) -a < $< | sed "s/^## \(.*\.\)/### \1/g" > $@
+	$(DOX) -r < $< | node support/dox2md.js > $@
 
 # $ make v/0.1.0
 # Makes a distribution.

Reference.md

@@ -1,54 +1,49 @@
-  - [Flatdoc](#flatdoc)
-  - [Flatdoc.run()](#flatdocrun)
-  - [Flatdoc.file()](#flatdocfile)
-  - [Flatdoc.github()](#flatdocgithub)
-  - [Parser](#parser)
-  - [Parser.parse()](#parserparse)
-  - [Transformer](#transformer)
-  - [Transformer.mangle()](#transformermangle)
-  - [Transformer.addIDs()](#transformeraddids)
-  - [Transformer.getMenu()](#transformergetmenu)
-  - [Transformer.buttonize()](#transformerbuttonize)
-  - [Transformer.smartquotes()](#transformersmartquotes)
-  - [Highlighters](#highlighters)
-  - [MenuView](#menuview)
-  - [Runner](#runner)
-  - [Runner.run()](#runnerrun)
-  - [Runner.applyData()](#runnerapplydata)
-
-## Flatdoc
-
-  Flatdoc.
+Flatdoc
+=======
+
+Basic Flatdoc module.
+
+The main entry point is `Flatdoc.run()`, which invokes the [Runner].
+
+```js
+Flatdoc.run({
+  fetcher: Flatdoc.github('rstacruz/backbone-patterns');
+});
+```
+
+
 
 ### Flatdoc.run()
 
-  Runs.
+Creates a runner.
+See [Flatdoc].
 
 ### Flatdoc.file()
 
-  File fetcher function.
-  
-  Fetches a given `url` via AJAX.
-  See [Runner#run()] for a description of fetcher functions.
+File fetcher function.
+
+Fetches a given `url` via AJAX.
+See [Runner#run()] for a description of fetcher functions.
 
 ### Flatdoc.github()
 
-  Github fetcher.
-  Fetches from repo `repo` (in format 'user/repo').
-  
-  If the parameter `filepath` is supplied, it fetches the contents of that
-  given file in the repo.
-  
-  See [Runner#run()] for a description of fetcher functions.
-  
-  See: http://developer.github.com/v3/repos/contents/
+Github fetcher.
+Fetches from repo `repo` (in format 'user/repo').
 
-## Parser
+If the parameter `filepath` is supplied, it fetches the contents of that
+given file in the repo.
+
+See [Runner#run()] for a description of fetcher functions.
+
+See: http://developer.github.com/v3/repos/contents/
+
+Parser
+------
+
+Parser module.
+Parses a given Markdown document and returns a JSON object with data
+on the Markdown document.
 
-  Parser module.
-  Parses a given Markdown document and returns a JSON object with data
-  on the Markdown document.
-  
 ```js
 var data = Flatdoc.parser.parse('markdown source here');
 console.log(data);
@@ -63,41 +58,43 @@ data == {
 }
 ```
 
+
+
 ### Parser.parse()
 
-  Parses a given Markdown document.
-  See `Parser` for more info.
+Parses a given Markdown document.
+See `Parser` for more info.
 
-## Transformer
+Transformer
+-----------
+
+Transformer module.
+This takes care of any HTML mangling needed.  The main entry point is
+`.mangle()` which applies all transformations needed.
 
-  Transformer module.
-  This takes care of any HTML mangling needed.  The main entry point is
-  `.mangle()` which applies all transformations needed.
-  
 ```js
 var $content = $("<p>Hello there, this is a docu...");
 Flatdoc.transformer.mangle($content);
 ```
 
-  
-  If you would like to change any of the transformations, decorate any of
-  the functions in `Flatdoc.transformer`.
+If you would like to change any of the transformations, decorate any of
+the functions in `Flatdoc.transformer`.
 
 ### Transformer.mangle()
 
-  Takes a given HTML `$content` and improves the markup of it by executing
-  the transformations.
-  
-  > See: [Transformer](#transformer)
+Takes a given HTML `$content` and improves the markup of it by executing
+the transformations.
+
+> See: [Transformer](#transformer)
 
 ### Transformer.addIDs()
 
-  Adds IDs to headings.
+Adds IDs to headings.
 
 ### Transformer.getMenu()
 
-  Returns menu data for a given HTML.
-  
+Returns menu data for a given HTML.
+
 ```js
 menu = Flatdoc.transformer.getMenu($content);
 menu == {
@@ -108,61 +105,87 @@ menu == {
     items: [...]}, ...]}
 ```
 
+
+
 ### Transformer.buttonize()
 
-  Changes "button >" text to buttons.
+Changes "button >" text to buttons.
 
 ### Transformer.smartquotes()
 
-  Applies smart quotes to a given element.
-  It leaves `code` and `pre` blocks alone.
+Applies smart quotes to a given element.
+It leaves `code` and `pre` blocks alone.
 
-## Highlighters
+Highlighters
+------------
+
+Syntax highlighters.
+
+You may add or change more highlighters via the `Flatdoc.highlighters`
+object.
 
-  Syntax highlighters.
-  
-  You may add or change more highlighters via the `Flatdoc.highlighters`
-  object.
-  
 ```js
 Flatdoc.highlighters.js = function(code) {
 };
 ```
 
-  
-  Each of these functions
+Each of these functions
 
-## MenuView
+### Highlighters.js
 
-  Menu view. Renders menus
+JavaScript syntax highlighter.
 
-## Runner
+Thanks @visionmedia!
+
+MenuView
+--------
+
+Menu view. Renders menus
+
+Runner
+------
+
+A runner module that fetches via a `fetcher` function.
 
-  A runner module that fetches via a `fetcher` function.
-  
 ```js
 var runner = new Flatdoc.runner({
   fetcher: Flatdoc.url('readme.txt')
 });
 runner.run();
 ```
 
-  
-  The following options are available:
-  
-   - `fetcher` - a function that takes a callback as an argument and
-```js
- executes that callback when data is returned.
-```
+The following options are available:
 
-  
-  See: [Flatdoc.run()]
+ - `fetcher` - a function that takes a callback as an argument and
+   executes that callback when data is returned.
+
+See: [Flatdoc.run()]
+
+### Runner#run()
+
+Loads the Markdown document (via the fetcher), parses it, and applies it
+to the elements.
 
-### Runner.run()
+### Runner#applyData()
 
-  Loads the Markdown document (via the fetcher), parses it, and applies it
-  to the elements.
+Applies given doc data `data` to elements in object `elements`.
 
-### Runner.applyData()
 
-  Applies given doc data `data` to elements in object `elements`.
+[Flatdoc]: #flatdoc
+[Flatdoc.run()]: #flatdoc-run
+[Flatdoc.file()]: #flatdoc-file
+[Flatdoc.github()]: #flatdoc-github
+[Parser]: #parser
+[Parser.parse()]: #parser-parse
+[Transformer]: #transformer
+[Transformer.mangle()]: #transformer-mangle
+[Transformer.addIDs()]: #transformer-addids
+[Transformer.getMenu()]: #transformer-getmenu
+[Transformer.buttonize()]: #transformer-buttonize
+[Transformer.smartquotes()]: #transformer-smartquotes
+[Highlighters]: #highlighters
+[Highlighters.js]: #highlighters-js
+[MenuView]: #menuview
+[Runner]: #runner
+[Runner#run()]: #runner-run
+[Runner#applyData()]: #runner-applydata