rename some files, update README, mini refactor

Author: mixmix

README.md

@@ -4,8 +4,10 @@ This is a dynamic mardkown transclusion server - it parses special inclusion syn
 
 parts of the project: 
 
-- builder.js, which accepts text, and a callback. It fetches md / hmd file from the web translcuding then hands the result to the callback
-- a server which you can point at an hmd file. It uses the builder to transclude and then render the markdown
+- `treeBuilder( markdownText, callback )` : reads text and recursively fetches markdown files that have been linked to in the `+[file name](url)` format. It stores the markdown (original and fetched) in a json tree, and passes this to the callback.
+- `treePartialRender( tree )` : renders the markdown partials of a built tree into html, and returns that tree.
+- `treeToHtml( tree )` : provides a couple of methods for rendering tree of html partials into a a single html string.
+- server : serves client static files, and provides and api which client-side code can request built and rendered trees of markdown.
 
 ## notation
 
@@ -16,3 +18,9 @@ e.g.
 +[example include](https://github.com/mixmix/example-course/blob/master/README.md)
 ```
 
+With normal markdown renderers this makes a link like this: 
+
++[example include](https://github.com/mixmix/example-course/blob/master/README.md)
+
+[See this same file rendered by hypermarkdown](https://hypermarkdown.herokuapp.com)
+

regexps.js

@@ -1,5 +1,5 @@
 module.exports = {
-  'mdUrl':                      /\.md(\#[\w-_]*)?/)
+  'mdUrl':                      /\.md(\#[\w-_]*)?/,
   'githublab':                  /git(hub|lab).com/,
   'youtubeTransclusionAnchors': /\+\<a[^>]+(www.youtube.com[^<]+<\/a>)/g,
   'youtubeId':                  /v\=([a-zA-Z\d]+)[&'"]+/,

server.js

@@ -8,8 +8,8 @@ var fs = require('fs')
 var request = require('request')
 var stringify = require('json-stringify-safe') 
 
-var build = require('./builder')
-var renderTree = require('./renderTree')
+var treeBuild = require('./treeBuild')
+var treePartialRender = require('./treePartialRender')
 var fetchAuthors = require('./fetchAuthors')
 var regexps = require('./regexps')
 
@@ -34,7 +34,7 @@ function buildHypermarkdownTree(req, res, match) {
   var source = requestDetails.query.source
 
   if (source && source.match( regexps.mdUrl ) ) {
-    build(source, function(err, tree) {
+    treeBuild(source, function(err, tree) {
       if (err) { 
         res.writeHead(400, {'content-type': 'text/plain'})
         res.write("You've hit a bad url somewhere in there, we got the error:<br />"+ err)
@@ -44,8 +44,8 @@ function buildHypermarkdownTree(req, res, match) {
 
       res.writeHead(200, {'content-type': 'application/json'})
 
-      var renderedTree = renderTree(tree)
-      res.write( stringify(renderedTree, null, 2) )
+      tree = treePartialRender(tree)
+      res.write( stringify(tree, null, 2) )
       res.end()
     })
   }

builder.js renamed to treeBuild.js

@@ -11,19 +11,9 @@ module.exports = function( url, callback ) {
     depth: 0,
   })
 
-  dig( parentTree, callback )
+  expandTree( parentTree, callback )
 }
 
-if (!module.parent) {
-  var url = 'http://github.com/mixmix/example-course/blob/master/mix-recipe.md'
-
-  module.exports(url, function (err, results) {
-    if (err) { throw err }
-    var renderedTree = renderTreeContent(results)
-    console.log(renderedTree)
-    console.log(treeToHtml(renderedTree))
-  })
-}
 
 function Tree( attrs ) {
   return {
@@ -45,7 +35,7 @@ function treeWithParent( treeNode ) {
   }
 }
 
-function dig( treeNode, callback ) {
+function expandTree( treeNode, callback ) {
   if (isInfiniteLoop(treeNode)) return callback(null, treeNode)
 
   var getUrl = makeRaw(treeNode.url)
@@ -64,7 +54,7 @@ function dig( treeNode, callback ) {
 
     async.each( 
       treeNode.children,
-      dig,
+      expandTree,
       function (err) {
         callback(err, treeNode)
       }

renderTree.js renamed to treePartialRender.js

@@ -1,10 +1,10 @@
 var Markdown = require('markdown-it')
 var md = new Markdown()
 
-module.exports = function renderTreeContent( tree ) {
+module.exports = function treePartialRender( tree ) {
   tree.content = md.render(tree.content)
   tree.children.forEach(function (childTree) {
-    renderTreeContent(childTree)
+    treePartialRender(childTree)
   })
   return tree
 }