- changes summary:

- install ink-docstrap
- configure jsdocs
- add custom jsdoc plugin
- add yarn docs script
- move markdown folder inside docs
- move samples folder inside docs

Author: Isaac Ramirez

.gitignore

@@ -1,4 +1,8 @@
-# Logs
+# docs output
+docs/html/*
+!docs/html/.gitkeep
+
+# logs
 logs
 *.log
 npm-debug.log*
@@ -7,4 +11,4 @@ yarn-error.log*
 lerna-debug.log*
 
 # npm modules
-node_modules/
+node_modules

README.md

@@ -10,10 +10,6 @@ Personal notes and JavaScript code for the book Algorithms (4th edition) by Robe
 * [StdOut](/src/libs/std-out/std-out.js)
 * [StdRandom](/src/libs/std-random/std-random.js)
 
-## Benchmarks
-
-* [Linear Search vs. Binary Search](/src/benchmarks/searching/linear-vs-binary-search.js)
-
 ## Algorithms & Data Structures
 
 _For a list similar to the book site see this [algorithms list](/markdown/algorithms.md)._
@@ -72,3 +68,7 @@ _For a list similar to the book site see this [algorithms list](/markdown/algori
 ## Exercise Solutions
 
 :warning: _Do **NOT** copy any of [these solutions](/src/exercises/index.md). These are for my reference only. You should have attempted to solve any of these exercises by your own after at least a few days before even trying to look for the solution. Finally, my solutions can be wrong too._
+
+## Benchmarks
+
+* [Linear Search vs. Binary Search](/benchmarks/searching/linear-vs-binary-search.js)

docs/conf.json

@@ -0,0 +1,46 @@
+{
+  "plugins": [
+    "plugins/markdown",
+    "plugins/my-tags"
+  ],
+  "markdown": {
+    "tags": ["note"]
+  },
+  "recurseDepth": 10,
+  "source": {
+    "include": ["./src"],
+    "exclude": [],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_|.+\\.spec\\.js$"
+  },
+  "sourceType": "module",
+  "opts": {
+    "template": "./node_modules/ink-docstrap/template",
+    "encoding": "utf8",
+    "destination": "./docs/html",
+    "recurse": true,
+    "readme": "./README.md"
+  },
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false,
+    "default": {
+      "outputSourceFiles": true,
+      "staticFiles": {
+        "include": ["./static"]
+      },
+      "includeDate": false,
+      "useLongnameInNav": false
+    },
+    "theme": "simplex",
+    "includeDate": false,
+    "navType": "vertical",
+    "inverseNav": false,
+    "linenums": true,
+    "sort": false
+  }
+}

docs/html/.gitkeep

@@ -0,0 +1 @@
+The contents of this folder are auto-generated by issuing the command: yarn docs

markdown/algorithms.md renamed to docs/markdown/algorithms.md

@@ -0,0 +1,13 @@
+exports.defineTags = function (dictionary) {
+  dictionary.defineTag('note', {
+    onTagged: function (doclet, tag) {
+      const note = `<p><em><strong>NOTE:</strong>&nbsp;${tag.text}</em></p>`
+
+      if (doclet.classdesc) {
+        doclet.classdesc = `${doclet.classdesc}${note}`
+      } else {
+        doclet.description = `${doclet.description || ''}${note}`
+      }
+    }
+  })
+}

markdown/exercise.template.md renamed to docs/markdown/exercise.template.md

@@ -1,6 +1,6 @@
 /** @module samples */
 
-const { StdOut } = require('../src/libs')
+const { StdOut } = require('../../src/libs')
 
 /**
  * @summary Exercise x.x.x

docs/plugins/my-tags.js

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "Personal notes & JavaScript code for the book: Algorithms 4th edition by Robert Sedgewick and Kevin Wayne.",
   "scripts": {
+    "docs": "jsdoc -c docs/conf.json --pedantic --verbose",
     "lint": "standard \"src/**/*.js\"",
     "lint:fix": "yarn lint --fix",
     "pretest": "yarn lint",
@@ -31,6 +32,7 @@
   },
   "devDependencies": {
     "d3": "^5.15.1",
+    "ink-docstrap": "^1.3.2",
     "jasmine": "^3.6.3",
     "jsdoc": "~3.6.6",
     "jsdom": "^16.4.0",