Skip to content

fix: invalid code snippet in ecosystem/packages/markdown-remark.mdx#210

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:fix/ecosystem/packages/markdown-remark
Jan 24, 2026
Merged

fix: invalid code snippet in ecosystem/packages/markdown-remark.mdx#210
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:fix/ecosystem/packages/markdown-remark

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Jan 24, 2026

Description

Fixes an invalid code snippet in ecosystem/packages/markdown-remark.mdx.
This was spotted by coderabbit in #208. I think that's correct looking at the type:
https://github.com/withstudiocms/markdown-remark/blob/a8bda1899459cd30f75c9569b1b8687dea125eff/packages/markdown-remark/src/types.ts#L54-L58

Summary by CodeRabbit

  • Documentation
    • Updated example usage showing the correct way to pass custom components to the renderer, clarifying the expected options structure for implementation.

✏️ Tip: You can customize this high-level summary in your review settings.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner January 24, 2026 13:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

Documentation update to the markdown-remark package showing corrected example code for passing custom components to the renderer via a components key instead of an inline object structure.

Changes

Cohort / File(s) Summary
Documentation Update
src/content/docs/en/ecosystem/packages/markdown-remark.mdx
Updated example usage showing how to pass custom components to renderer via components: {custom: Custom} instead of inline structure; added trailing newline to code block

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • Adammatthiesen

Poem

🐰 With whiskers twitching, I've found the way,
Components nested, examples at play,
The docs now gleam with structure so bright,
Correct and clear, everything right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing an invalid code snippet in a specific documentation file. It is concise, clear, and directly related to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Jan 24, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/ecosystem/packages/markdown-remark.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@dreyfus92 dreyfus92 merged commit c0186a9 into withstudiocms:main Jan 24, 2026
9 checks passed
@ArmandPhilippot ArmandPhilippot deleted the fix/ecosystem/packages/markdown-remark branch January 24, 2026 20:16
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jan 24, 2026
dreyfus92 added a commit that referenced this pull request Jan 24, 2026
* i18n(fr): add `markdown-remark.mdx` & `studiocms-ui.mdx`

See #194

* add changes from #210

---------

Co-authored-by: paul valladares <85648028+dreyfus92@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants