Made plugin compatible with TypeDoc 0.22.x #447
Merged
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
kamiazya
approved these changes
Oct 24, 2021
|
@all-contributors please add @RunDevelopment for code, test |
|
I've put up a pull request to add @RunDevelopment! 🎉 |
|
@RunDevelopment great work! @kamiazya any chance of having this released in the near time? |
|
@azatoth Yes. The reason it couldn't be released is that the CI in the main branch is failing. If this can be fixed, I'll release it, but I haven't had time. (If you can fix it, please fix it🙏) |
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.
Hello @kamiazya!
Since I want this plugin in my docs, I updated everything to be compatible with TypeDoc 0.22.x. Unfortunately, I had to reimplement essentially the entire plugin, so almost nothing of the old code remains.
The new implementation only uses TypeDoc's public-facing API, so it will hopefully work with future TypeDoc versions for a long while.
I also had to remove E2E test since I couldn't get it to compile. The other tests have been updated.
One problem that I haven't addressed yet is that using an h4 in
@mermaidtags looks strange.Maybe we should use bold text instead? We could also display the h4 on the next line.
This fixes #441.