add TypeDoc to project

TypeDoc will generate a documentation site which we can publish to github pages.
guardian · Jan 15, 2021 · c5e61fd · c5e61fd
1 parent 4074e25
commit c5e61fd
Show file tree

Hide file tree

Showing 7 changed files with 675 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 # Generated / builds
 lib
+target
 
 # IDEs
 .idea

diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ find useful scripts within the [`script`](./script) directory for common tasks.
 
 - `./script/setup` to install dependencies
 - `./script/start` to run the Jest unit tests in watch mode
+- `./script/docs` to generate documentation and view in the browser
 - `./script/lint` to lint the code using ESLint
 - `./script/test` to run the Jest unit tests
 - `./script/build` to compile TypeScript to JS
-Original file line number
+Diff line change
@@ -1,5 +1,6 @@
     # Generated / builds
     lib
+    target
     # IDEs
     .idea
@@ Expand Down @@