API

Package

Polen is an ESM only package. If you are using CJS, then you need NodeJS version >=22.0.0 to require it.

/‌

Overview

You can import the Polen namespace from the root entrypoint or you can import its bare exports from polen/polen.

import { Polen } from 'polen'
import { defineConfig } from 'polen/polen'

console.log(Polen.defineConfig === defineConfig) // true

Value Polen.defineConfig(config)

Define your Polen configuration with type safety. Learn more at Configuration

Value Polen.VitePlugin

Vite plugin for integrating Polen into a custom Vite setup. This is an advanced feature for users who need more control over their build process.

import { Polen } from 'polen'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    Polen.VitePlugin({
      // Polen configuration
    }),
  ],
})

Type Polen.ConfigInput

TypeScript type for the configuration input.

/polen

Bare exports within the Polen namespace see /.

/components

Polen provides React components for use in MDX pages. Learn more at Arbitrary Pages.