Support github links in markdown output

documentationjs · Nov 9, 2015 · eed48f7 · eed48f7
1 parent 8a2ec3e
commit eed48f7
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/lib/output/markdown_ast.js b/lib/output/markdown_ast.js
@@ -5,7 +5,7 @@ var mdast = require('mdast'),
 
 /**
  * Given a hierarchy-nested set of comments, generate an mdast-compatible
- * Abstract Syntax Usable for generating Markdown output
+ * Abstract Syntax Tree usable for generating Markdown output
  *
  * @param {Array<Object>} comments nested comment
  * @param {Object} opts currently none accepted
@@ -93,7 +93,19 @@ function commentsToAST(comments, opts, callback) {
       });
     }
 
+    function githubLink(comment) {
+      return comment.context.github && u('paragraph', [
+        u('link', {
+          title: 'Source code on GitHub',
+          href: comment.context.github
+        }, [u('text', comment.context.path + ':' +
+          comment.context.loc.start.line + '-' +
+          comment.context.loc.end.line)])
+      ]);
+    }
+
     return [u('heading', { depth: depth }, [u('text', comment.name)])]
+    .concat(githubLink(comment))
     .concat(mdast.parse(formatInlineTags(comment.description)).children)
     .concat(paramSection(comment))
     .concat(propertySection(comment))

diff --git a/test/fixture/simple.output.github.md b/test/fixture/simple.output.github.md
@@ -0,0 +1,7 @@
+# simple.input
+
+[test/fixture/simple.input.js:5-8]([github] "Source code on GitHub")
+
+This function returns the number one.
+
+Returns **Number** numberone
diff --git a/test/test.js b/test/test.js
@@ -29,7 +29,17 @@ if (fs.existsSync(path.join(__dirname, '../.git'))) {
       }
       var expect = require(outputfile);
       t.deepEqual(result, expect);
-      t.end();
+
+      outputMarkdown(result, null, function (err, result) {
+        t.ifError(err);
+        var outputfile = file.replace('.input.js', '.output.github.md');
+        if (UPDATE) {
+          fs.writeFileSync(outputfile, result, 'utf8');
+        }
+        var expect = fs.readFileSync(outputfile, 'utf8');
+        t.equal(result.toString(), expect, 'markdown output correct');
+        t.end();
+      });
     });
   });
 }