Add hyphenation hints on compile time & use text justification

This commit adds proper hyphenation hints to the documentation
at doc compile time; these hints can be used to portably use
`text-align: justified` with nice hyphenation.

This looks nice & fits more information, especially on small screens.

Author: koraa

package.json

@@ -15,7 +15,10 @@
   "devDependencies": {
     "jsdoc": "latest",
     "browser-sync": "latest",
-    "watch-run": "latest"
+    "watch-run": "latest",
+    "hyphenation.en-gb": "^0.2.1",
+    "hypher": "^0.2.5",
+    "jsdom": "^15.1.1"
   },
   "author": "Clement Moron <[email protected]>",
   "license": "Apache-2.0",

publish.js

@@ -9,7 +9,11 @@ var path = require('jsdoc/path');
 var taffy = require('taffydb').taffy;
 var template = require('jsdoc/template');
 var util = require('util');
+var jsdom = require('jsdom');
+var Hypher = require('hypher');
+var hypher_en = require('hyphenation.en-gb');
 
+var hypher = new Hypher(hypher_en);
 var htmlsafe = helper.htmlsafe;
 var linkto = helper.linkto;
 var resolveAuthorLinks = helper.resolveAuthorLinks;
@@ -475,6 +479,35 @@ function buildNav(members) {
     return nav;
 }
 
+function hyphenate_dom(node) {
+  if (node.nodeName === '#text') {
+    node.nodeValue = hypher.hyphenateText(node.nodeValue);
+  }
+  for (const child of node.childNodes) {
+    hyphenate_dom(child);
+  }
+}
+
+function hyphenate_prop(obj, prop) {
+  var dom = new jsdom.JSDOM(obj[prop]);
+  hyphenate_dom(dom.window.document.body);
+  obj[prop] = dom.window.document.body.innerHTML;
+}
+
+function hyphenate_doclet(doclet) {
+  hyphenate_prop(doclet, 'classdoc');
+  hyphenate_prop(doclet, 'description');
+  for (const param of doclet.params || []) {
+      hyphenate_prop(param, 'description');
+  }
+  for (const prop of doclet.properties || []) {
+      hyphenate_prop(prop, 'description');
+  }
+  for (const ret of doclet.returns || []) {
+      hyphenate_prop(ret, 'description');
+  }
+}
+
 /**
     @param {TAFFY} taffyData See <http://taffydb.com/>.
     @param {object} opts
@@ -536,8 +569,10 @@ exports.publish = function(taffyData, opts, tutorials) {
                     doclet.longname = doclet.longname.replace(/^'(.*)'$/, '$1');
                 }
             }
-         }
-         doclet.attribs = '';
+        }
+        doclet.attribs = '';
+
+        hyphenate_doclet(doclet);
 
         if (doclet.examples) {
             doclet.examples = doclet.examples.map(function(example) {

static/styles/jsdoc.css

@@ -47,6 +47,7 @@ article .description a {
 p, ul, ol, blockquote {
   margin-bottom: 1em;
   line-height: 160%;
+  text-align: justify;
 }
 
 h1, h2, h3, h4, h5, h6 {