Postkit

Postkit is a portable publishing toolkit for rendering structured articles across React, email, Next.js, React Router, TanStack Router, and Astro. It combines an article component system, Markdown and MDX tooling, framework-aware links, and provider-neutral URL metadata resolution.

Use Postkit when content should keep its meaning while the application, router, or rendering environment changes.

Framework adapters depend on @postkit/react; install the adapter that matches the application rather than assembling its routing integration by hand.

Install Postkit and its peer dependencies:

npm install @postkit/react @chakra-ui/react @emotion/react react react-dom

Mount PostkitProvider, then use individual components or the supplied MDX component map:

import {
  createPostkitMdxComponents,
  Callout,
  PostkitProvider,
} from '@postkit/react';

export const mdxComponents = createPostkitMdxComponents();

export function Article() {
  return (
    <PostkitProvider>
      <main>
        <h1>Portable publishing</h1>
        <Callout title="Keep the content" tone="tip">
          Change the renderer without changing the article.
        </Callout>
      </main>
    </PostkitProvider>
  );
}

For a framework application, continue with its package guide:

• Next.js
• React Router
• TanStack Router
• Astro

HTML, Markdown, MDX, JSON, or structured declarations
                    |
       @postkit/core document contract
                    |
      Component or framework renderer
                    |
     Site theme, router, and resolvers
                    |
          Rendered article output

Postkit owns the portable content contract and structural presentation. Its React renderer inherits the host Chakra system by default; applications can opt into postkitDefaultTheme for Postkit's standalone visual preset. The application still owns its outer layout, routing policy, asset pipeline, secrets, and server-side unfurling service.

@postkit/unfurl is deliberately separate from rendering. It normalizes remote metadata behind a server or build-time boundary; components consume the normalized result without receiving provider credentials.

• Component and theming guide
• Email rendering guide
• Shiki code-block adapter
• Unfurling and oEmbed guide
• Astro integration and hydration policy
• Executable framework and service examples
• Generated TypeScript API reference
• Agent documentation index
• Contributing
• Release process
• Changelog

The documentation site and generated component catalog live in apps/site. Package READMEs remain self-contained because npm renders the README from each published package.

Postkit is in its initial public release series. Public APIs are typed and release artifacts are tested in a clean consumer, but additions and refinements should be expected before 1.0.

@postkit/prismark remains in the Prismark workspace until @prismark/component-protocol is published independently.

Postkit is available under the MIT License.

See compatibility and environments for rendering details, support for issue guidance, and the security policy for private vulnerability reporting and trust boundaries.