Open
Conversation
Co-Authored-By: alec@buildwithfern.com <alecharmon@outlook.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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.
Summary
Adds an example page demonstrating how to use reusable
<Markdown src="..." />snippets inside<Tooltip>components to maintain a single-source glossary. Created in response to support ticket #17232 where a customer wanted to share glossary definitions across docs via tooltips.Changes:
tooltip-snippets.mdxwith usage instructions and a live exampleperennial.mdx,propagation.mdx,hardiness-zone.mdx) with plant-themed definitionsdocs.ymlThe technique uses the string attribute syntax:
<Tooltip tip="<Markdown src='/snippets/glossary/term.mdx' />">. The Fern CLI resolves<Markdown>tags via regex at build time, replacing them with file contents before MDX compilation. This means the snippet text gets inlined into thetipstring attribute.Local testing
Tested locally with
fern docs dev— all three tooltips render correctly with snippet content:Screen recording of full test:
View original video (rec-93f84ce3e59c49689951d2fea14238a1-edited.mp4)
Review & Testing Checklist for Human
Recommended test plan: Open the preview, hover over each underlined term, and confirm the tooltip shows the correct definition text without extra whitespace or raw tags.
Notes
tipstring attribute will not render. The page includes a note about this limitation.