Skip to content

Add TanStack Markdown and Highlight#1056

Open
tannerlinsley wants to merge 7 commits into
mainfrom
taren/add-markdown-highlight-libraries
Open

Add TanStack Markdown and Highlight#1056
tannerlinsley wants to merge 7 commits into
mainfrom
taren/add-markdown-highlight-libraries

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Jul 21, 2026

Copy link
Copy Markdown
Member

What changed

  • registers TanStack Markdown and TanStack Highlight as public UI & UX libraries
  • adds library metadata, navigation, stats, sitemap, OG colors, maintainer ownership, versioned routes, and redirect coverage
  • replaces the shared content-tools template with two independent marketing pages
  • gives Markdown an editorial publishing story around its public AST, deliberate syntax profile, safety contract, renderer parity, extensions, and bundle size
  • gives Highlight a code-lab story around selective language registration, synchronous output, semantic CSS themes, embedded-language scanners, annotations, corpus benchmarks, and explicit tradeoffs
  • sharpens both library taglines and descriptions across discovery surfaces

Why

Markdown and Highlight solve adjacent problems, but the shared landing-page structure flattened the product differences. Their marketing now follows the architecture and constraints that make each library distinctive.

Impact

Both libraries appear across library discovery and navigation with launch pages that explain when to choose them, what they deliberately leave out, and how they compose without implying that one depends on the other.

Validation

  • pnpm test
  • type-aware lint and TypeScript checks
  • light and dark mode visual checks at desktop and 390px mobile widths for both landing pages
  • docs source validation: Markdown 24/24 paths, Highlight 30/30 paths

Summary by CodeRabbit

  • New Features
    • Added TanStack Markdown and TanStack Highlight to the library catalog and navigation.
    • Added dedicated versioned landing pages with interactive demonstrations, documentation links, benchmarks, and integration guidance.
    • Added routing, metadata, branding, and accent colors for both libraries.
  • Bug Fixes
    • Updated legacy documentation redirects to support Markdown and Highlight overview pages.
  • Chores
    • Updated the Markdown package version.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d6924619-bfbe-4c46-b8d2-53ab05578ced

📥 Commits

Reviewing files that changed from the base of the PR and between 4962bf1 and 4442b46.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (14)
  • package.json
  • src/components/landing/HighlightLanding.tsx
  • src/components/landing/MarkdownLanding.tsx
  • src/libraries/ids.ts
  • src/libraries/index.tsx
  • src/libraries/libraries.ts
  • src/libraries/maintainers.ts
  • src/routeTree.gen.ts
  • src/routes/-library-landing.tsx
  • src/routes/_library/$libraryId/$version.index.tsx
  • src/routes/_library/highlight.$version.index.tsx
  • src/routes/_library/markdown.$version.index.tsx
  • src/server/og/colors.ts
  • tests/docs-redirects.test.ts

📝 Walkthrough

Walkthrough

Adds TanStack Markdown and TanStack Highlight as public libraries with interactive landing pages, package metadata, versioned routes, redirects, generated route types, maintainer data, accent colors, and updated redirect tests.

Changes

Library registration and metadata

Layer / File(s) Summary
Library registry and public metadata
package.json, src/libraries/*, src/server/og/colors.ts
Registers markdown and highlight identifiers, metadata, exports, grouping, maintainer ownership, accent colors, and updates the Markdown package version.

Markdown landing experience

Layer / File(s) Summary
Markdown interactive landing page
src/components/landing/MarkdownLanding.tsx
Adds Markdown demonstrations for AST/HTML/React views, editable parsing, streaming replay, escaping, installation, syntax support, and bundle comparisons.

Highlight landing experience

Layer / File(s) Summary
Highlight interactive landing page
src/components/landing/HighlightLanding.tsx
Adds Highlight marketing sections with themed code output, bundle profiles, theme contracts, embedded-language mapping, annotations, benchmarks, and integration choices.

Versioned routing and redirects

Layer / File(s) Summary
Versioned landing routes and redirects
src/routes/*, src/routeTree.gen.ts, tests/docs-redirects.test.ts
Adds Markdown and Highlight version routes, route type wiring, static landing redirects, and legacy redirect expectations.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Browser
  participant LibraryRoute
  participant loadLibraryLandingRouteData
  participant MarkdownLanding

  Browser->>LibraryRoute: Request /markdown/$version
  LibraryRoute->>loadLibraryLandingRouteData: Load library and version data
  loadLibraryLandingRouteData-->>LibraryRoute: Return landing data
  LibraryRoute->>MarkdownLanding: Render selected version
  MarkdownLanding-->>Browser: Display interactive landing page
Loading

Possibly related PRs

Suggested reviewers: kevinvandy

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding TanStack Markdown and Highlight as new libraries and landing pages.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/add-markdown-highlight-libraries

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

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 21, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com 4442b46 Commit Preview URL

Branch Preview URL
Jul 23 2026, 10:35 PM

@tannerlinsley
tannerlinsley marked this pull request as ready for review July 23, 2026 22:34
@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Added@​tanstack/​markdown@​0.0.11771009796100

View full report

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.

1 participant