feat(docusaurus-plugin-typedoc): Add new includeExtension option to docusaurus plugin #293
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
|
Thanks @francis-robert this is a great idea. I actually swapped it so its 'true' by default as that does seem to be the 'correct' config. |
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.
Had the same issue as in #289, however, there is an edge-case in the
index.mdfile where references toindexalso need to remove the.mdsuffix or else you're left with paths such as../.md.Decided to not only fix the bug but make it configurable as well, adding to the documentation, configs, and updating the tests.
This PR would add a new
includeExtensionoption which isfalseby default, preserving existing behavior. If set to true, it would allow users to opt-in to the new behavior by choice instead of being forced into it (and potentially breaking other edge-cases)