Skip to content

docs([DST-1163]) : Raw markdown view for documentation pages#5095

Draft
sinan-rsvx wants to merge 19 commits intomainfrom
DST-1163-raw-markdown-view-for-documentation-pages
Draft

docs([DST-1163]) : Raw markdown view for documentation pages#5095
sinan-rsvx wants to merge 19 commits intomainfrom
DST-1163-raw-markdown-view-for-documentation-pages

Conversation

@sinan-rsvx
Copy link
Contributor

Description

This PR introduces a parser that converts all MDX documentation files in our design system to plain Markdown (.md) files. The main goal is to prepare our documentation for the upcoming MCP server, which will use these Markdown files as its primary data source.

  • Adds a build step that scans all MDX files in the documentation, parses them, and outputs equivalent Markdown files.

  • Translates all MDX/JSX syntax to Markdown and inlines the content of all imported or custom components, so the resulting Markdown is fully self-contained.

  • Only code from <ComponentDemo> is inlined and preserved as code blocks; all other JSX and imports are resolved or removed.

Test Instructions:

Run the following command to build the Markdown documentation and check docs/app/mcp/output/ for generated md files.

pnpm build:md-docs

Reviewers:

@marigold-ui/developer

Pull Request Checklist:

  • Marigold docs and Storybook Preview is available
  • Added/updated unit tests and storybook for this change (for new code or code which already has tests).
  • Added/Updated documentation (if it already exists for this component).
  • Updated visual regression tests (only necessary when ui changes in the PR)

@vercel
Copy link

vercel bot commented Feb 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marigold-fumadocs Ready Ready Preview, Comment Feb 13, 2026 1:44pm
marigold-storybook Ready Ready Preview, Comment Feb 13, 2026 1:44pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
marigold-production Ignored Ignored Feb 13, 2026 1:44pm
marigold-docs Skipped Skipped Feb 13, 2026 1:44pm

Request Review

@changeset-bot
Copy link

changeset-bot bot commented Feb 3, 2026

⚠️ No Changeset found

Latest commit: dcf5ec8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the type:docs Improvements or additions to documentation label Feb 3, 2026
@sinan-rsvx sinan-rsvx changed the title Dst 1163 raw markdown view for documentation pages docs([DST-1163]) : Raw markdown view for documentation pages Feb 3, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Coverage Report for Marigold Code Coverage

Status Category Percentage Covered / Total
🔵 Lines 96.82% 1431 / 1478
🔵 Statements 96.36% 1483 / 1539
🔵 Functions 94.85% 406 / 428
🔵 Branches 89.84% 911 / 1014
File CoverageNo changed files found.
Generated in workflow #19546 for commit dcf5ec8 by the Vitest Coverage Report Action

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Accessibility tests executed. Download the report here.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Accessibility tests executed. Download the report here.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Accessibility tests executed. Download the report here.

@sebald
Copy link
Member

sebald commented Feb 9, 2026

When using fumadocs we will no longer generate the JSON 🙈 maybe we can use the stuff from fuma to get the types?

@sinan-rsvx sinan-rsvx force-pushed the DST-1163-raw-markdown-view-for-documentation-pages branch from 714c642 to 27e4377 Compare February 13, 2026 13:14
@github-actions
Copy link
Contributor

Accessibility tests executed. Download the report here.

@github-actions
Copy link
Contributor

Accessibility tests executed. Download the report here.

@github-actions
Copy link
Contributor

Accessibility tests executed. Download the report here.

@github-actions
Copy link
Contributor

Accessibility tests executed. Download the report here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants