Using: https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown
We can use typedoc to generate markdown instead of HTML.
This makes far more sense for a source repository to have markdown, and not HTML.
HTML is too noisy for source documentation.
Might actually make our PRs smaller when generating docs.
Also need to experiment with using the gh command line in the CI/CD to later submit PRs to update the docs.
I wonder how many docs files it updates though.
Using: https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown
We can use
typedocto generate markdown instead of HTML.This makes far more sense for a source repository to have markdown, and not HTML.
HTML is too noisy for source documentation.
Might actually make our PRs smaller when generating docs.
Also need to experiment with using the
ghcommand line in the CI/CD to later submit PRs to update the docs.I wonder how many docs files it updates though.