docs: generate doc from tsdoc

[lihbr]

Types of changes

• [x] Chore (a non-breaking change which is related to package maintenance)
• [ ] Bug fix (a non-breaking change which fixes an issue)
• [ ] New feature (a non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Description

This PR adds generated documentation from TSDoc using typedoc and a fork of typedoc-plugin-markdown. typedoc-plugin-markdown has been forked to fine-tune its output a bit.

Generated documentation can be browsed here: https://github.com/prismicio/prismic-types/tree/doc/generate-doc-from-tsdoc/typedoc#readme

Related code of the fork (and the quick CLI script) is living here: https://github.com/prismicio/prismic-typedoc

The overall API is pretty limited but let me know if you have any improvement ideas!

Checklist:

• [ ] My change requires an update to the official documentation.
• [x] All TSDoc comments are up-to-date and new ones have been added where necessary.
• [x] All new and existing tests are passing.

[lihbr]

TODO: turn H4 into bold to simplify GitHub TOC

[codecov-commenter]

Codecov Report

Merging #28 (d15dccd) into master (c4fbec2) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master       #28   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines           17        17           
=========================================
  Hits            17        17           

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c4fbec2...d15dccd. Read the comment docs.

[lihbr]

Updated the generator to use a more coherent sort order and disabled H4 & H5 so that TOC make sense, pretty happy with it!

[lihbr]

I don't think we'll move forward with this anymore, closing for now.

Also archived https://github.com/prismicio/prismic-typedoc

[angeloashmore]

Still a good idea, though. Maybe we can revisit when we have time.