@page-speed/markdown-to-jsx

@page-speed/markdown-to-jsx

A performance-optimized, tree-shakable React markdown renderer for the DashTrack ecosystem. Wraps the lightweight markdown-to-jsx library (~6KB gzipped) with ecosystem-specific defaults: pre-configured overrides for @page-speed/img and @page-speed/pressable, prose-aware typography, and zero-CLS rendering. Used by the UI component library for the OpenSite Semantic Site Builder platform.

Features

• Performance-first: Lightweight (~8KB gzipped) with minimal dependencies
• Tree-shakable: Import only what you need
• SSR compatible: Works with Next.js and other SSR frameworks
• Type-safe: Full TypeScript support
• Secure: Built-in XSS protection and URL sanitization
• Customizable: Easy to override default components
• Ecosystem integration: Seamless integration with @page-speed/img

Installation

npm install @page-speed/markdown-to-jsx
# or
pnpm add @page-speed/markdown-to-jsx
# or
yarn add @page-speed/markdown-to-jsx

Optional Peer Dependencies

For optimized image rendering, install @page-speed/img:

npm install @page-speed/img

Quick Start

Basic Usage

import { Markdown } from "@page-speed/markdown-to-jsx";

function MyComponent() {
  return (
    <Markdown>
      # Hello World

      This is **bold** and this is *italic*.

      [Link](https://example.com)
    </Markdown>
  );
}

With Custom Styling

<Markdown className="prose prose-lg">
  # Styled Markdown

  Your content here...
</Markdown>

Using the Hook

import { useMarkdown } from "@page-speed/markdown-to-jsx/hooks";

function MyComponent() {
  const { content } = useMarkdown("# Hello from hook!");

  return <div>{content}</div>;
}

API

<Markdown> Component

Primary component for rendering markdown content.

interface MarkdownProps {
  children: string;
  className?: string;
  wrapper?: string | ComponentType<any>;
  overrides?: OverrideMap;
  useDefaults?: boolean;
  sanitize?: boolean;
}

Props:

• children (required): Markdown string to render
• className: Custom CSS class for the wrapper element
• wrapper: Custom wrapper component (defaults to 'div')
• overrides: Custom component overrides
• useDefaults: Enable default ecosystem overrides (default: true)
• sanitize: Enable HTML sanitization (default: true)

useMarkdown Hook

Hook for compiling markdown to JSX.

function useMarkdown(
  markdown: string,
  options?: MarkdownOptions
): UseMarkdownResult

Returns:

interface UseMarkdownResult {
  content: ReactNode;
  isCompiling: boolean;
  error?: Error;
}

useMarkdownOptions Hook

Hook for merging custom options with defaults.

function useMarkdownOptions(
  options?: MarkdownOptions
): MarkdownOptions

Custom Overrides

You can override any HTML element with a custom React component:

import { Markdown } from "@page-speed/markdown-to-jsx";

const CustomH1 = ({ children, ...props }) => (
  <h1 className="text-4xl font-bold text-blue-600" {...props}>
    {children}
  </h1>
);

function MyComponent() {
  return (
    <Markdown overrides={{ h1: CustomH1}}>
      # Custom Heading Style
    </Markdown>
  );
}

Default Overrides

The library includes these default overrides:

• Headings (h1-h6): Auto-generated IDs for anchor links
• Images (img): Integration with @page-speed/img for optimized loading
• Links (a): Automatic external link handling with security attributes
• Code blocks (pre, code): Language detection and syntax highlighting support
• Tables: Responsive table wrapper

Tree-Shakable Imports

Import only what you need for optimal bundle size:

// Import individual components
import { H1, H2 } from "@page-speed/markdown-to-jsx/overrides";

// Import specific utilities
import { slugify } from "@page-speed/markdown-to-jsx/utils";

// Import hooks
import { useMarkdown } from "@page-speed/markdown-to-jsx/hooks";

Utilities

Slugification

import { slugify, generateHeadingId } from "@page-speed/markdown-to-jsx/utils";

const slug = slugify("Hello World"); // "hello-world"
const id = generateHeadingId("Introduction"); // "introduction"

Sanitization

import { sanitizeUrl, sanitizeAttributes } from "@page-speed/markdown-to-jsx/utils";

const safeUrl = sanitizeUrl("javascript:alert('XSS')"); // "#"
const safeAttrs = sanitizeAttributes({ onclick: "alert('XSS')" }); // {}

Examples

Blog Post Rendering

import { Markdown } from "@page-speed/markdown-to-jsx";

function BlogPost({ content }) {
  return (
    <article className="prose prose-lg max-w-none">
      <Markdown>{content}</Markdown>
    </article>
  );
}

Documentation Page

import { Markdown } from "@page-speed/markdown-to-jsx";

function DocsPage({ markdown }) {
  return (
    <div className="documentation">
      <Markdown
        className="docs-content"
        overrides={{
          h1: ({ children }) => (
            <h1 className="docs-heading-1">{children}</h1>
          ),
          code: ({ children }) => (
            <code className="docs-code">{children}</code>
          ),
        }}
      >
        {markdown}
      </Markdown>
    </div>
  );
}

Dynamic Content

import { useMarkdown } from "@page-speed/markdown-to-jsx/hooks";

function DynamicContent({ markdownSource }) {
  const { content, isCompiling, error } = useMarkdown(markdownSource);

  if (isCompiling) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;

  return <div>{content}</div>;
}

Performance

• Bundle size: ~8KB gzipped (base library)
• Tree-shakable: Import only what you need
• Memoized: Automatic memoization prevents unnecessary re-renders
• Zero runtime overhead: Pre-compiled components

Security

The library includes built-in security features:

• XSS protection through URL sanitization
• Dangerous protocol detection (javascript:, data:, vbscript:)
• Event handler attribute stripping
• Safe external link handling with rel="noopener noreferrer"

TypeScript

Full TypeScript support with comprehensive type definitions:

import type {
  MarkdownProps,
  MarkdownOptions,
  OverrideMap
} from "@page-speed/markdown-to-jsx";

License

MIT

Contributing

See BUILD_GUIDE.md for development instructions.

Repository

https://github.com/opensite-ai/markdown-to-jsx

Advanced Features

Custom Heading IDs with {#id} Syntax

The library supports custom heading IDs using the {#id} syntax, which is commonly used by AI LLMs and extended markdown parsers:

<Markdown>
  {`
## Introduction {#intro}

Content here... can link to [Introduction](#intro)

## Getting Started {#getting-started}

More content...
  `}
</Markdown>

Output:

<h2 id="intro">Introduction</h2>
<p>Content here... can link to <a href="#intro">Introduction</a></p>
<h2 id="getting-started">Getting Started</h2>

Features:

• ✅ AI-friendly syntax - matches patterns used by Claude, GPT, and other LLMs
• ✅ Perfect for table of contents and anchor links
• ✅ Falls back to auto-generated IDs when {#id} not specified
• ✅ Works seamlessly with section navigation

Custom Styling with markdownStyles

Apply custom Tailwind classes to markdown elements without creating custom components:

<Markdown
  markdownStyles={{
    h2: 'text-2xl md:text-4xl font-bold text-primary',
    h3: 'text-xl md:text-2xl font-semibold',
    img: 'shadow-lg rounded-2xl aspect-video',
    iframe: 'aspect-video w-full rounded-2xl shadow-lg my-12',
    p: 'text-base md:text-lg leading-relaxed',
    blockquote: 'border-l-4 border-primary pl-4 italic',
  }}
>
  {markdownContent}
</Markdown>

Supported Elements:

• Headings: h1, h2, h3, h4, h5, h6
• Text: p, blockquote, code, pre
• Media: img, iframe
• Lists: ul, ol, li
• Tables: table, thead, tbody, tr, th, td
• Links: a

Iframe Support

The library now includes built-in iframe support for embeds (YouTube, Twitter, Spotify, etc.):

<Markdown
  markdownStyles={{
    iframe: 'aspect-video w-full rounded-lg shadow-md my-8'
  }}
>
  {`
## Video Tutorial

<iframe 
  src="https://www.youtube.com/embed/VIDEO_ID" 
  title="Tutorial Video"
></iframe>

Content continues...
  `}
</Markdown>

Default iframe attributes:

• loading="lazy" - Lazy loading for performance
• allowFullScreen - Enables fullscreen mode
• Security attributes automatically applied

Combining Features

All features work together seamlessly:

<Markdown
  markdownStyles={{
    h2: 'text-3xl font-bold text-primary mb-6',
    img: 'rounded-xl shadow-lg',
    iframe: 'aspect-video w-full rounded-2xl my-12',
  }}
  overrides={{
    a: CustomLinkComponent, // Use custom component for links
  }}
>
  {`
## Video Section {#videos}

Watch our tutorial below:

<iframe src="https://youtube.com/embed/abc123"></iframe>

![Screenshot](https://example.com/img.jpg)

For questions, email us at [e-mail] or call [phone].
  `}
</Markdown>

What happens:

• Heading gets custom ID id="videos" + custom styling
• Iframe gets custom className + lazy loading
• Image uses @page-speed/img with responsive formats + custom styling
• Email link auto-converts to mailto:[e-mail]
• Phone link auto-converts to tel:[phone]