📝 Swith to typedoc for the API Reference #936
Merged
+551
−353
Conversation
This file contains hidden or 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
One of the plus, provided by TypeDoc is that it supports function overload nicely. As a consequence, tuple<T0>, tuple<T0,T1>... and other overloads appear under the same label. At the same time, display is less pretty but it can be customized. I just want to see if I can get something pretty with a bit of CSS magic and certainly tailwindcss.
Revert towards 'invalid' syntax for the moment.
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2436dd3:
|
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.
While typedoc does not offer all the capabilities we had on docsify, it generates a very cool documentation for our 'API Reference'. As a matter of fact, our 'generated API' will now only contain a 'Reference API'.
On its side, docsify had many issues:
property_1,property_2...On typedoc side some things would have to be added or fixed:
ContextandcontextIn a nutshell
❌ New feature
❌ Fix an issue
✔️ Documentation improvement
❌ Other: please explain
(✔️: yes, ❌: no)
Potential impacts
None.