@fullstackdatasolutions/articles 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2026-07-30
+
+### Added
+
+- Added `mdxComponents` to `ArticlesConfig`, allowing consuming apps to register React components for explicit use inside article MDX bodies. Registered components are merged with the package's built-in MDX image override.
+
 ## [0.10.0] - 2026-07-23
 
 ### Added

package/README.md

@@ -454,12 +454,39 @@ Use this if you don't need a custom API base path. For custom paths, use `create
 | `defaultAuthor`        | `string`                                            | —                    | Default author slug or name used when article frontmatter omits both `authors` and `author`.                                                        |
 | `breadcrumbs`          | `false \| BreadcrumbsConfig`                        | default trails       | Set to `false` to hide breadcrumbs, or configure article/category/author breadcrumb trails, custom URL items, separator, schema output, and labels. |
 | `linkTargetStrategy`   | `'external-new-tab' \| 'all-new-tab' \| 'same-tab'` | `'external-new-tab'` | Controls article body links. Internal links open in the same window by default; external `http`/`https` links open in a new window.                 |
+| `mdxComponents`        | `Record<string, ComponentType<never>>`              | -                    | Components exposed to article `.mdx` bodies by tag name. Merged with the built-in MDX image override.                                               |
 | `description`          | `string`                                            | —                    | Short description used as the RSS feed channel description. Falls back to `siteName` if omitted.                                                    |
 
 **Default layout order:** `['hero', 'search', 'featured', 'latest', 'categories']`
 
 To add a newsletter section, pass `layout: ['hero','search','featured','latest','categories','newsletter']` — the library renders `null` for `'newsletter'` so you can append your own component after `<ArticlesPage />`.
 
+### Custom MDX components
+
+Pass React components through `mdxComponents` to make them available to article `.mdx` files. The component key is the JSX tag authors write in the article.
+
+```tsx
+// config/articles.ts
+import type { ArticlesConfig } from '@fullstackdatasolutions/articles'
+import { LeadMagnetCTA } from '@/components/LeadMagnetCTA'
+
+export const siteConfig: ArticlesConfig = {
+  siteUrl: 'https://yoursite.com',
+  siteName: 'Your Site',
+  mdxComponents: {
+    LeadMagnetCTA,
+  },
+}
+```
+
+```mdx
+Article intro paragraph.
+
+<LeadMagnetCTA system="DND" segment="new-players" />
+```
+
+Imports inside individual `.mdx` article files are not supported. Define components in the consuming app and register them through `mdxComponents`.
+
 ### Authors
 
 Author profiles are optional. If an article has no configured author and no plain `author` frontmatter, author UI and author metadata are omitted for that article.