Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/unified-mdx-components.md

This file was deleted.

1 change: 0 additions & 1 deletion .changeset/workflow-step-interface.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
'mdxui': patch
'@mdxui/ink': patch
---

Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/basic-browser/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/basic-browser",
"private": true,
"version": "0.1.0",
"description": "Complete MDX browser with editing, preview, and file management capabilities",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/browser/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/browser",
"private": true,
"version": "0.1.0",
"description": "Browser component for viewing, editing, and previewing MDX content",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/chrome/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/chrome",
"private": true,
"version": "0.2.0",
"description": "Chrome extension for rendering MDX files with Monaco editor and Shiki",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/core/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/core",
"private": true,
"type": "module",
"version": "0.0.0",
"sideEffects": [
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/ink/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/ink",
"private": true,
"version": "0.1.0",
"description": "Create CLI apps using MDX with React Ink and Pastel",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/magicui/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/magicui",
"private": true,
"type": "module",
"version": "0.0.0",
"sideEffects": [
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/mcp/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/mcp",
"private": true,
"version": "0.1.0",
"description": "Model Context Protocol server for MDX files",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/react/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/react",
"private": true,
"version": "0.0.0",
"description": "React components for mdxui with dual API support",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/reveal/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/reveal",
"private": true,
"type": "module",
"version": "0.0.0",
"sideEffects": [
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/safari/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/safari",
"private": true,
"type": "module",
"version": "0.0.0",
"description": "Safari extension for rendering text, markdown, mdx, and mdxld files with Monaco Editor",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/semantic-mapping/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/semantic-mapping",
"private": true,
"version": "0.0.0",
"description": "Semantic MDX parser that extracts structured props from markdown children",
"type": "module",
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/shadcn/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/shadcn",
"private": true,
"type": "module",
"version": "0.0.0",
"sideEffects": [
Expand Down
1 change: 1 addition & 0 deletions packages/@mdxui/types/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@mdxui/types",
"private": true,
"version": "0.0.0",
"description": "TypeScript types for mdxui components",
"type": "module",
Expand Down
55 changes: 55 additions & 0 deletions packages/mdxui/DEPRECATED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# `mdxui` in this repo is DEPRECATED — and it is a name collision, not just dead code

**The published `mdxui` on npm is not this package.** It is
[`dot-do/ui` → `packages/mdxui`](https://github.com/dot-do/ui/tree/main/packages/mdxui).

| | this repo (`dot-do/mdx`) | the published package (`dot-do/ui`) |
|---|---|---|
| version | `0.1.0` | `6.1.0` in-repo, `7.0.0-alpha.1` on npm (`latest`) |
| npm identity | **none** — never published from here | every published version of `mdxui`, `0.0.0` → `7.0.0-alpha.1`, records `repository: dot-do/ui` |
| what it exports | `Button`, `Card`, `Slides`, `Slide`, and the namespace objects `Core` / `Shadcn` / `Ink` / `Magicui` / `Browser` | Business-as-Code higher-order abstractions — `./site`, `./app`, `./admin`, `./zod`, `./templates` |

## The two APIs are disjoint

This is the part that makes the collision dangerous rather than merely untidy. The two packages share
a name and share **nothing else**. Anything that resolves `mdxui` to the wrong one does not get a
version mismatch — it gets a module with none of the expected exports.

## What changed here, and what did not

**Changed:** every package under `packages/mdxui` and `packages/@mdxui/*` in this repo is now
`"private": true`, so `changeset publish` cannot push any of them to npm. Two pending changesets
(`unified-mdx-components.md`, and the `mdxui` half of `workflow-step-interface.md`) declared a
`mdxui` release from this repo; they have been removed. Had a release run before this change, this
repo would have published `mdxui@0.2.0` and **moved the npm `latest` tag off `dot-do/ui`'s
`7.0.0-alpha.1`**.

**Not changed:** the workspace name is still `mdxui`, so in-repo consumers still resolve and build.
Renaming it is the *next* step, not this one — see below.

## Do not import `mdxui` from this repo

New code in this repo should import the underlying `@mdxui/*` workspace packages directly
(`@mdxui/core`, `@mdxui/shadcn`, `@mdxui/magicui`, `@mdxui/browser`, `@mdxui/ink`, …) rather than the
`mdxui` barrel. New code **outside** this repo that wants `mdxui` wants `dot-do/ui`.

## Remaining in-repo consumers — these block the delete

| consumer | how it couples |
|---|---|
| `packages/mdxe` | `dependencies: { "mdxui": "workspace:*" }`, and `src/template/components/mdx-components.tsx` imports `{ Button, Card, Core, Shadcn, Magicui, Browser } from 'mdxui'` |
| `packages/@mdxui/mcp` | declares `mdxui` as a dependency |
| `examples/deck`, `examples/payload-blog` | declare `mdxui` as a dependency |
| `README.md`, `examples/blog/getting-started-with-mdxe.mdx` | document `import … from 'mdxui'` |

`mdxe` is the one that matters: it is a live, published package whose scaffolding template emits an
`import … from 'mdxui'` into user projects. **In a user's project that import resolves to npm — i.e.
to `dot-do/ui`'s `mdxui`, which has none of those exports.** Migrating `mdxe` off the barrel and onto
explicit `@mdxui/*` imports is the prerequisite for deleting this directory.

## Why this exists

Recorded for the next agent so the reasoning is not re-derived: the owner ruled on 2026-08-03 that
"the mdxui in the mdx repo is old and needs mostly deprecated … the new mdxui packages are in the ui
repo … and mdxui needs to be removed from the mdx repo and refer to the ui repo." Tracked as
`dot-do/vis#166` (which upgrades `dot-do/vis#145` from "dead code" to "name collision").
6 changes: 6 additions & 0 deletions packages/mdxui/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# `mdxui` – Component Library for MDX

> **⚠ DEPRECATED — and this is not the `mdxui` published on npm.**
> The published `mdxui` is [`dot-do/ui` → `packages/mdxui`](https://github.com/dot-do/ui/tree/main/packages/mdxui),
> a different package with a disjoint API. Every package under `packages/mdxui` and
> `packages/@mdxui/*` **in this repo** is now `private` and cannot be published.
> Read [DEPRECATED.md](./DEPRECATED.md) before touching anything here.

`mdxui` is a collection of UI packages that provide ready‑to‑use React components for Markdown and MDX content. Each package focuses on a different environment—from web apps to the terminal. All packages can be used individually or through the main `mdxui` bundle, which re‑exports them under namespaces like `Core`, `Shadcn` and `Ink`.

```ts
Expand Down
3 changes: 2 additions & 1 deletion packages/mdxui/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"name": "mdxui",
"private": true,
"type": "module",
"version": "0.1.0",
"description": "MDX UI components library",
"description": "DEPRECATED — not the published `mdxui`. This is the mdx repo's legacy in-repo barrel; the published mdxui lives at github.com/dot-do/ui (packages/mdxui). See DEPRECATED.md.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
Expand Down
Loading