Document parameterized markdown snippets feature #1865
Merged
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
Co-Authored-By: Catherine Deskur <[email protected]>
Contributor
Author
🤖 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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| <CodeBlock title='fern/snippets/common-warning.mdx'> | ||
| ```mdx | ||
| <Warning> | ||
| This feature is in beta and may change in future releases. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'future' that become outdated
Contributor
Co-Authored-By: Catherine Deskur <[email protected]>
| @@ -0,0 +1,23 @@ | |||
| ## Parameterized markdown snippets | |||
|
|
|||
| Reusable markdown snippets can now accept arbitrary parameters that can be used as variables in the snippet. This enables flexible, reusable content templates. | |||
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
fern/snippets/common-warning.mdx
Outdated
| @@ -0,0 +1,3 @@ | |||
| <Warning> | |||
| This feature is in beta and may change in future releases. | |||
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'future' that become outdated
Contributor
…ts page Co-Authored-By: Catherine Deskur <[email protected]>
Contributor
Contributor
Contributor
devalog
approved these changes
Nov 8, 2025
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.
Document parameterized markdown snippets feature
Summary
Added documentation for parameterized markdown snippets, which allow snippets to accept arbitrary parameters as variables. The documentation was added as Step 4 to the existing reusable snippets page, maintaining consistency with the existing tutorial structure and plant-themed examples.
Changes:
reusable-markdown.mdxwith examples showing single and multiple parameter usagewatering-schedule.mdx,plant-care.mdx) used in the live Preview tabReview & Testing Checklist for Human
<Markdown src="/snippets/watering-schedule.mdx" plant="peace lily" interval="3" />renders "Water your peace lily every 3 days" (not literal{plant}text). This is the core functionality being documented./learn/docs/writing-content/reusable-snippetsin the preview and verify the Preview tab in Step 4 shows the correctly substituted textTest Plan
{plant}or{interval})Notes
watering-schedule.mdxfile and the parameterized snippet feature working correctlyLink to Devin run: https://app.devin.ai/sessions/933babf4471a4d7ca89763ad492ef797
Requested by: Catherine Deskur ([email protected])