API docs #57
Open
API docs #57
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to be documented in TypeDoc
Mostly copied from the one in Langium
|
@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? |
|
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 am in no hurry :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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