Highlight all Markdown, not just examples. Fixes #610 (#613)

* Highlight all Markdown, not just examples. Fixes #610

* Fix html output fixture

* Remove unrelated change

Author: tmcw

lib/output/highlighter.js

@@ -0,0 +1,22 @@
+var visit = require('unist-util-visit');
+var hljs = require('highlight.js');
+
+/**
+ * Adapted from remark-highlight.js
+ * https://github.com/ben-eb/remark-highlight.js
+ * @param {Object} node AST node
+ * @returns {undefined} modifies the node by reference
+ * @private
+ */
+function visitor(node) {
+  if (node.lang) {
+    node.type = 'html';
+    node.value = '<pre class=\'hljs\'>' +
+      hljs.highlightAuto(node.value, [node.lang]).value + '</pre>';
+  }
+}
+
+module.exports = function (ast) {
+  visit(ast, 'code', visitor);
+  return ast;
+};

lib/output/util/formatters.js

@@ -3,6 +3,7 @@ var remark = require('remark'),
   Syntax = require('doctrine').Syntax,
   u = require('unist-builder'),
   _rerouteLinks = require('./reroute_links'),
+  highlighter = require('../highlighter'),
   formatType = require('./format_type');
 
 /**
@@ -46,7 +47,9 @@ module.exports = function (getHref) {
    */
   formatters.markdown = function (ast) {
     if (ast) {
-      return remark().use(html).stringify(rerouteLinks(ast));
+      return remark()
+        .use(html)
+        .stringify(highlighter(rerouteLinks(ast)));
     }
   };
 

test/bin.js

@@ -182,6 +182,24 @@ test('invalid arguments', function (group) {
   group.end();
 });
 
+test('--config', options, function (t) {
+  var dst = path.join(os.tmpdir(), (Date.now() + Math.random()).toString());
+  fs.mkdirSync(dst);
+  var outputIndex = path.join(dst, 'index.html');
+  var expectedOutputPath = path.join(__dirname, 'fixture/html/nested.config-output.html');
+  documentation(['build -c fixture/html/documentation.yml -f html fixture/html/nested.input.js -o ' +
+    dst], function (err) {
+    t.notOk(err);
+    var output = fs.readFileSync(outputIndex, 'utf8');
+    if (process.env.UPDATE) {
+      fs.writeFileSync(expectedOutputPath, output);
+    }
+    var expectedOutput = fs.readFileSync(expectedOutputPath, 'utf8');
+    t.equal(expectedOutput, output, 'generates correct output');
+    t.end();
+  }, false);
+});
+
 test('--version', options, function (t) {
   documentation(['--version'], {}, function (err, output) {
     t.ok(output, 'outputs version');

test/fixture/html/documentation.yml

@@ -0,0 +1,22 @@
+toc:
+  - name: Highlighted section
+    description: |
+      The public key is a base64 encoded string of a protobuf containing an RSA DER
+      buffer. This uses a node buffer to pass the base64 encoded public key protobuf
+      to the multihash for ID generation.
+
+      ```js
+      var PeerId = require('peer-id')
+
+      PeerId.create({ bits: 1024 }, (err, id) => {
+        console.log(JSON.stringify(id.toJSON(), null, 2)
+      })
+      ```
+
+      ```
+      {
+        "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
+        "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
+        "pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
+      }
+      ```