Refine documentation

[jonw-cogapp]

• Pivotal ticket: #185595742
• Other Relevant Links (Mailing list discussion, related pull requests, etc.)

What does this Pull Request do?

Tooling

• Adds husky (managing git hooks)
• Adds lint-staged (managing scope of git hooks)
• Adds new lint:typecheck for completeness
• Adds pre-commit hook which will:
  • Run lint-staged, performing specific actions on .ts and .css files
  • Run the typedoc generator if any Typescript files are staged

Code

• Moved some things around in the constructor to avoid the instanceId incrementing if the viewer didn't initialise
• Renamed index.ts to StoriiiesViewer.ts for clarity
• Added JSDoc comments (primarily to improve output of typedoc)
  • N.B. Using JSDoc for readonly was preferable to the TypeScript keyword due to some things unavoidably needing to be assigned outside of the constructor or inside the .then(), which would result in a tsc compile error

Bundle output

• Changed the output directories to umd and esm, this seemed preferable

Documentation

• Made tables full width (in admittedly as slightly hacky way)
• Added bit about what shape of manifests we support
• Generated typedoc files

Other notes

• I included a plugin that alters how typedoc treats a default export otherwise the constructor method in the documentation advises users to use new default(config), which is patently incorrect.
• See https://jonw-cogapp.github.io/sv-preview/api/ for Typedoc site

Test coverage

Yes/No: Are changes in this pull-request covered by:

• Cypress tests?

Interested parties

@tristanr-cogapp

[iainb-cogapp]

@jonw-cogapp I've suggested a couple of minor tweaks to the Readme but otherwise looks great

[jonw-cogapp]

@iainb-cogapp Thanks, I've implemented your suggestions 👍

[jonw-cogapp]

@tristanr-cogapp Let me know after you've had a read through this if you have any feedback

[tristanr-cogapp]

LGTM, but please see typo suggestions inline in the README.

Also, shouldn't there be a link somewhere in the README to all the API docs?