Project: Add API doc generation via TypeDoc.

Author: microbit-carlos

config/typedoc.json

@@ -0,0 +1,48 @@
+{
+  "name": "Universal Hex API Docs",
+  "inputFiles": ["./src"],
+  "readme": "./docs/api-readme.md",
+  "exclude": [
+    "**/__tests__/**/*"
+  ],
+  "mode": "modules",
+  "out": "./docs/api",
+  "excludeExternals": true,
+  "excludeNotExported": true,
+  "excludeProtected": true,
+  "excludePrivate": true,
+  "stripInternal": true,
+  "includeVersion": true,
+  "hideGenerator": false,
+  "theme": "./node_modules/typedoc-neo-theme/bin/default",
+  "source": [{
+    "path": "https://github.com/microbit-foundation/microbit-universal-hex/tree/v0.2.1/src/",
+    "line": "L"
+  }],
+  "links": [{
+      "label": " | ",
+      "url": null
+    }, {
+      "label": " Universal Hex Spec ",
+      "url": "https://github.com/microbit-foundation/spec-universal-hex/"
+    }, {
+      "label": " | ",
+      "url": null
+    }, {
+      "label": " General Docs ",
+      "url": "https://microbit-foundation.github.io/microbit-universal-hex/"
+    }, {
+      "label": " | ",
+      "url": null
+    }, {
+      "label": " micro:bit Tech Site ",
+      "url": "https://tech.microbit.org/"
+    }
+  ],
+  "outline": [{
+      "Public API": {
+        "Universal Hex module": "modules/_universal_hex_"
+      }
+    }
+  ]
+}

docs/_config.yml

@@ -7,6 +7,10 @@ kramdown:
   # Interprets line breaks literally
   hard_wrap: false
 
+# Exclude this file as it will be used for the TypeDoc API docs generator
+exclude:
+  - api-readme.md
+
 # Just The Docs settings
 
 # Enable or disable the site search

docs/api-readme.md

@@ -0,0 +1,35 @@
+# Universal Hex API Documentation
+
+This is the API documentation for the micro:bit Universal Hex TypeScript
+library.
+
+<p align="center"><img width="50%" alt="microbit-universal-hex logo" src="https://raw.githubusercontent.com/microbit-foundation/microbit-universal-hex/master/docs/img/microbit-uh-logo.png"></p>
+
+Here you will find the available public API to convert Intel Hex strings into Universal Hex strings and vice-versa.
+
+The source code is well annotated with in-line documentation and
+[TypeDoc](http://typedoc.org) is used to generate this HTML representation.
+
+## Navigation
+
+- ⬆️ Related links can be found on the header
+- ⬅️ Available public modules listed on the left
+- ➡️ (Within modules) Table of contents for interfaces and functions on the right
+- ⬆️ Search functionality can be found on the header as well
+
+## Rest Of The Documentation
+
+- [General documentation for this
+  library](https://microbit-foundation.github.io/microbit-universal-hex/)
+- [The micro:bit Universal Hex Specification contains a lot more information
+  about the file data format](https://github.com/microbit-foundation/spec-universal-hex)
+- [The micro:bit Tech Site contains general technical information about the
+  micro:bit](https://tech.microbit.org)
+
+## License
+
+This documentation, as well as the rest of the source files located in the
+https://github.com/microbit-foundation/microbit-universal-hex repository, is
+released under the MIT open source license.
+
+SPDX-License-Identifier: MIT