API docs

[aabounegm]

Adds automatic documentation generation using TypeDoc, which gets published to GitHub Pages on release (and also on manual trigger), just like in Langium.

A preview of the website can be found here for now: https://aabounegm.github.io/typir/

For it to work, the source in https://github.com/TypeFox/typir/settings/pages should be set to GitHub Actions

[JohannesMeierSE]

@aabounegm Thanks a lot for your PR!

We will include the API docs into a simple website for Typir (typir.org), which we want to establish soon. We will come back to your PR during that process. Is that fine for you?

[aabounegm]

Sure, I just thought it might be helpful to have them sooner rather than later, even if on a separate domain (as was done for Langium), but I'm in no hurry :)

[JohannesMeierSE]

@aabounegm Finally, we are in the phase of setting-up the website for Typir and would like to merge your PR. Could you rebase this PR in order to solve the conflicts? Adding more export keywords is fine. Otherwise I am happy to do the fixes on my own. Sorry for the slow progress on our side.

[aabounegm]

@JohannesMeierSE Absolutely! I'll gladly rebase, and then feel free to fix any remaining problems

[aabounegm]

I fixed the conflicts and pushed. But I should note that I couldn't update to the latest version of TypeDoc (v0.28.x) because apparently there is an incompatibility with typedoc-plugin-mermaid. Other than that, it should be ready.

[JohannesMeierSE]

Thanks again @aabounegm!

[JohannesMeierSE]

Looks fine: https://typefox.github.io/typir/