Add reference docs

[BasToTheMax]

For easier coding

[connerdouglass]

I really like this idea, and I'd like to make it automated before approving the PR. Instead of committing the typedoc HTML to the repo, let's make it automatically generate the docs every time there's a push.

Can you update your branch by deleting the docs folder you generated, and create a file at .github/workflows/docs.yml with the following content:

name: Docs

on: [push, pull_request]

jobs:
  build_and_lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v2

      - name: Setup Node.js
        uses: actions/setup-node@v2

      - name: Retrieve the cached "node_modules" directory (if present)
        uses: actions/cache@v2
        id: node-cache
        with:
          path: node_modules
          key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}

      - name: Install dependencies (if the cached directory was not found)
        if: steps.node-cache.outputs.cache-hit != 'true'
        run: npm ci

      - name: Test to see if the project compiles
        run: npm run build:check

      - name: Create the docs directory locally in CI
        run: npx typedoc src/index.ts

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.4
        with:
          branch: gh-pages
          folder: docs

It basically just runs npx typedoc src/index.ts every time there's a push to the repo on GitHub.

[BasToTheMax]

Done! I added the automation part!