feat(gatsby-theme-docz): include MDX transclusion support #1436
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
Palmaswell
changed the title
Palmaswell
changed the title
|
Nice, this is very clever. Any chance you can also add an example in examples to show how to use this ? Thanks ! |
|
Hi @rakannimer 👋, Glad to hear you like my suggestion. I can definitely create an example. What do you consider to be wiser?
|
|
Heyo ! I think I prefer option 2, it would be better to have it in a separate simpler example focusing on this feature only. |
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.
Description
The current gatsby-theme-docz version does not support MDX document transclusion. On the same token, trying to import an MDX document into a page and consume it as a component would throw an error. The thrown error causes the application to break as a side effect.
In this pull request, I solved this error issue and extended the functionality in the
base/Layout.jsby filtering pages and embedded MDX components.Document transclusion is a very useful and powerful feature for anyone documenting components and APIs. I hope this pull request can be included in the Docz project. Please let me know if you have any questions or need more information.