Execute npm run build

birkskyum · birkskyum · commit 9bc1098ec546 · 2022-08-04T02:05:16.000+02:00
diff --git a/docs/NODE_API.md b/docs/NODE_API.md
@@ -9,15 +9,12 @@
     *   [Parameters][5]
     *   [Examples][6]
 *   [formats][7]
-*   [formats.html][8]
+*   [formats.markdown][8]
     *   [Parameters][9]
     *   [Examples][10]
-*   [formats.markdown][11]
+*   [formats.json][11]
     *   [Parameters][12]
     *   [Examples][13]
-*   [formats.json][14]
-    *   [Parameters][15]
-    *   [Examples][16]
 
 ## lint
 
@@ -27,19 +24,19 @@ of lint information intended for human-readable output.
 
 ### Parameters
 
-*   `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
-*   `args` **[Object][19]** args
+*   `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
+*   `args` **[Object][16]** args
 
-    *   `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
+    *   `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
         that defines what external modules will be whitelisted and included in the
         generated documentation.
-    *   `args.shallow` **[boolean][20]** whether to avoid dependency parsing
-        even in JavaScript code. (optional, default `false`)
-    *   `args.inferPrivate` **[string][18]?** a valid regular expression string
+    *   `args.shallow` **[boolean][17]** whether to avoid dependency parsing
+        even in JavaScript code.&#x20;(optional, default `false`)
+    *   `args.inferPrivate` **[string][15]?** a valid regular expression string
         to infer whether a code element should be private, given its naming structure.
         For instance, you can specify `inferPrivate: '^_'` to automatically treat
         methods named like `_myMethod` as private.
-    *   `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
+    *   `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
         as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
 
 ### Examples
@@ -55,7 +52,7 @@ documentation.lint('file.js').then(lintOutput => {
 });
 ```
 
-Returns **[Promise][21]** promise with lint results
+Returns **[Promise][18]** promise with lint results
 
 ## build
 
@@ -64,27 +61,27 @@ comments, given a root file as a path.
 
 ### Parameters
 
-*   `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
-*   `args` **[Object][19]** args
+*   `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
+*   `args` **[Object][16]** args
 
-    *   `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
+    *   `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
         that defines what external modules will be whitelisted and included in the
         generated documentation.
-    *   `args.shallow` **[boolean][20]** whether to avoid dependency parsing
-        even in JavaScript code. (optional, default `false`)
-    *   `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that
-        defines sorting order of documentation (optional, default `[]`)
-    *   `args.access` **[Array][17]<[string][18]>** an array of access levels
-        to output in documentation (optional, default `[]`)
-    *   `args.hljs` **[Object][19]?** hljs optional args
-
-        *   `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
-        *   `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
-    *   `args.inferPrivate` **[string][18]?** a valid regular expression string
+    *   `args.shallow` **[boolean][17]** whether to avoid dependency parsing
+        even in JavaScript code.&#x20;(optional, default `false`)
+    *   `args.order` **[Array][14]<([string][15] | [Object][16])>** optional array that
+        defines sorting order of documentation&#x20;(optional, default `[]`)
+    *   `args.access` **[Array][14]<[string][15]>** an array of access levels
+        to output in documentation&#x20;(optional, default `[]`)
+    *   `args.hljs` **[Object][16]?** hljs optional args
+
+        *   `args.hljs.highlightAuto` **[boolean][17]** hljs automatically detect language&#x20;(optional, default `false`)
+        *   `args.hljs.languages` **[Array][14]?** languages for hljs to choose from
+    *   `args.inferPrivate` **[string][15]?** a valid regular expression string
         to infer whether a code element should be private, given its naming structure.
         For instance, you can specify `inferPrivate: '^_'` to automatically treat
         methods named like `_myMethod` as private.
-    *   `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
+    *   `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
         as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
 
 ### Examples
@@ -102,7 +99,7 @@ documentation.build(['index.js'], {
 });
 ```
 
-Returns **[Promise][21]** results
+Returns **[Promise][18]** results
 
 ## formats
 
@@ -111,37 +108,15 @@ and config as input and return Promises with results,
 like stringified JSON, markdown strings, or Vinyl objects for HTML
 output.
 
-## formats.html
-
-Formats documentation as HTML.
-
-### Parameters
-
-*   `comments` **[Array][17]<[Comment][22]>** parsed comments
-*   `config` **[Object][19]** Options that can customize the output
-
-    *   `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-
-documentation.build(['index.js'])
-  .then(documentation.formats.html);
-```
-
-Returns **[Promise][21]<[Array][17]<[Object][19]>>** Promise with results
-
 ## formats.markdown
 
 Formats documentation as
-[Markdown][23].
+[Markdown][19].
 
 ### Parameters
 
-*   `comments` **[Array][17]<[Object][19]>** parsed comments
-*   `args` **[Object][19]** Options that can customize the output
+*   `comments` **[Array][14]<[Object][16]>** parsed comments
+*   `args` **[Object][16]** Options that can customize the output
 
 ### Examples
 
@@ -157,15 +132,15 @@ documentation.build(['index.js'])
   });
 ```
 
-Returns **[Promise][21]<[string][18]>** a promise of the eventual value
+Returns **[Promise][18]<[string][15]>** a promise of the eventual value
 
 ## formats.json
 
 Formats documentation as a JSON string.
 
 ### Parameters
 
-*   `comments` **[Array][17]<[Comment][22]>** parsed comments
+*   `comments` **[Array][14]<[Comment][20]>** parsed comments
 
 ### Examples
 
@@ -181,7 +156,7 @@ documentation.build(['index.js'])
   });
 ```
 
-Returns **[Promise][21]<[string][18]>** 
+Returns **[Promise][18]<[string][15]>**&#x20;
 
 [1]: #lint
 
@@ -197,34 +172,28 @@ Returns **[Promise][21]<[string][18]>**
 
 [7]: #formats
 
-[8]: #formatshtml
+[8]: #formatsmarkdown
 
 [9]: #parameters-2
 
 [10]: #examples-2
 
-[11]: #formatsmarkdown
+[11]: #formatsjson
 
 [12]: #parameters-3
 
 [13]: #examples-3
 
-[14]: #formatsjson
-
-[15]: #parameters-4
-
-[16]: #examples-4
-
-[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[22]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
+[19]: https://daringfireball.net/projects/markdown/
 
-[23]: https://daringfireball.net/projects/markdown/
+[20]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
