MatrixAI / TypeScript-Demo-Lib

TypeScript Library Demo Project using Nix https://matrix.ai

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs generation should be in gh-pages

CMCDragonkai opened this issue · comments

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.