@valkyrianlabs/payload-markdown 1.3.1

package/dist/types/core.d.ts

@@ -0,0 +1,285 @@
+import type { JSX, ReactNode } from 'react';
+export type MarkdownRendererScope = 'blocks' | 'field';
+/**
+ * Options that control how fenced code blocks are rendered inside markdown content.
+ *
+ * By default, code blocks use the plugin's enhanced rendering mode:
+ * - `enhancedCodeBlocks` defaults to `true`
+ * - `lineNumbers` defaults to `true`
+ * - `theme` defaults to `'github-dark'`
+ *
+ * When enhanced rendering is enabled, the plugin applies its normalized code block
+ * pipeline on top of Shiki output. This includes layout cleanup, background
+ * normalization, and support for features like line numbers.
+ *
+ * When enhanced rendering is disabled, code blocks are rendered closer to raw
+ * Shiki output and plugin-specific enhancements are bypassed.
+ *
+ * These options are passed through the markdown rendering pipeline and primarily
+ * affect Shiki-rendered code fences.
+ */
+export type RenderMarkdownOptions = {
+    /**
+     * Whether to apply the plugin's enhanced code block rendering pipeline.
+     *
+     * Defaults to `true`.
+     *
+     * When enabled, the renderer performs structural and visual normalization on
+     * Shiki output to produce a consistent, content-focused appearance.
+     *
+     * When disabled, code blocks are rendered closer to raw Shiki output.
+     */
+    enhancedCodeBlocks?: boolean;
+    /**
+     * An optional list of language identifiers to load for Shiki syntax highlighting.
+     *
+     * By default, the plugin loads a core set of popular languages. You can replace
+     * that set entirely or extend it using spread syntax:
+     *
+     * ```ts
+     * options: {
+     *   langs: [...DEFAULT_CODE_LANGS, 'latex']
+     * }
+     * ```
+     */
+    langs?: string[];
+    /**
+     * Whether to show line numbers for fenced code blocks.
+     *
+     * Defaults to `true` when `enhancedCodeBlocks` is enabled.
+     *
+     * Line numbers require the enhanced rendering pipeline and are automatically
+     * disabled when `enhancedCodeBlocks` is set to `false`.
+     */
+    lineNumbers?: boolean;
+    /**
+     * The Shiki theme to use for syntax highlighting.
+     *
+     * Defaults to `'github-dark'`.
+     *
+     * The plugin's enhanced renderer is tuned around its default theme. When using a
+     * non-default theme:
+     *
+     * - `enhancedCodeBlocks: true` opts into the plugin's normalized rendering pipeline
+     * - `enhancedCodeBlocks: false` preserves the theme's native appearance more closely
+     *
+     * This allows you to choose between a more controlled presentation and a more
+     * theme-faithful rendering mode.
+     */
+    theme?: string;
+};
+export type MarkdownCodeConfig = {
+    /**
+     * Whether to apply the plugin's enhanced code block rendering pipeline.
+     */
+    enhanced?: boolean;
+    /**
+     * Whether fenced code blocks should extend beyond the normal content width
+     * on larger screens.
+     */
+    fullBleed?: boolean;
+    /**
+     * Optional list of language identifiers to load for Shiki syntax highlighting.
+     */
+    langs?: string[];
+    /**
+     * Whether to show line numbers for fenced code blocks.
+     */
+    lineNumbers?: boolean;
+    /**
+     * The Shiki theme to use for syntax highlighting.
+     */
+    shikiTheme?: string;
+};
+export type MarkdownDirectiveTheme = {
+    classes: string;
+    label?: string;
+    name: string;
+};
+export type MarkdownDirectiveThemeGroup = {
+    extendDefaults?: boolean;
+    items?: MarkdownDirectiveTheme[];
+} | MarkdownDirectiveTheme[];
+export type MarkdownDirectiveThemes = {
+    callout?: MarkdownDirectiveThemeGroup;
+    card?: MarkdownDirectiveThemeGroup;
+    cards?: MarkdownDirectiveThemeGroup;
+    cell?: MarkdownDirectiveThemeGroup;
+    columns?: MarkdownDirectiveThemeGroup;
+    details?: MarkdownDirectiveThemeGroup;
+    section?: MarkdownDirectiveThemeGroup;
+    steps?: MarkdownDirectiveThemeGroup;
+    tab?: MarkdownDirectiveThemeGroup;
+    tabs?: MarkdownDirectiveThemeGroup;
+    toc?: MarkdownDirectiveThemeGroup;
+};
+/**
+ * The result of compiling markdown into sanitized HTML.
+ */
+export type RenderMarkdownResult = {
+    /**
+     * The rendered HTML output.
+     */
+    html: string;
+    /**
+     * Non-fatal warnings produced during rendering.
+     */
+    warnings: string[];
+};
+/**
+ * Preset visual styles for rendered markdown content.
+ */
+export type MarkdownVariant = 'blog' | 'compact' | 'docs' | 'unstyled';
+/**
+ * Preset typography sizes for rendered markdown content.
+ */
+export type MarkdownSize = 'lg' | 'md' | 'sm';
+/**
+ * Core markdown presentation configuration.
+ *
+ * This type represents the configurable styling and behavior layer that can be
+ * sourced from plugin defaults, globals, collection defaults, or block-level
+ * overrides. It intentionally excludes runtime-only renderer props such as
+ * `markdown`, `as`, and fallback nodes.
+ */
+export type MarkdownConfig = {
+    /**
+     * Additional classes applied to the rendered markdown element itself.
+     */
+    className?: string;
+    /**
+     * Additional classes applied to column elements within the rendered markdown, if applicable.
+     *
+     * @deprecated Use directive themes instead.
+     */
+    columnClassName?: string;
+    /**
+     * Whether to apply horizontal gutter padding to the outer wrapper.
+     *
+     * Defaults to `false`.
+     */
+    enableGutter?: boolean;
+    /**
+     * Whether fenced code blocks should extend beyond the normal content width
+     * on larger screens.
+     *
+     * Defaults to `false`.
+     *
+     * @deprecated Use top-level or renderer-level `code.fullBleed` instead.
+     */
+    fullBleedCode?: boolean;
+    /**
+     * Optional content rendered above the markdown body.
+     */
+    lead?: ReactNode;
+    /**
+     * Whether heading colors should be slightly muted.
+     *
+     * Defaults to `false`.
+     */
+    mutedHeadings?: boolean;
+    /**
+     * Options that control fenced code block rendering.
+     *
+     * @deprecated Use top-level or renderer-level `code` instead.
+     */
+    options?: RenderMarkdownOptions;
+    /**
+     * Additional classes applied to section elements within the rendered markdown, if applicable.
+     *
+     * @deprecated Use directive themes instead.
+     */
+    sectionClassName?: string;
+    /**
+     * Typography size preset for the rendered markdown.
+     *
+     * Defaults to `'lg'`.
+     */
+    size?: MarkdownSize;
+    /**
+     * Visual style preset for the rendered markdown.
+     *
+     * Defaults to `'blog'`.
+     */
+    variant?: MarkdownVariant;
+    /**
+     * Additional classes applied to the outer wrapper element.
+     */
+    wrapperClassName?: string;
+};
+export type MarkdownRenderConfig = {
+    code?: MarkdownCodeConfig;
+    themes?: MarkdownDirectiveThemes;
+} & MarkdownConfig;
+/**
+ * Runtime-only props shared by markdown renderer components.
+ */
+export type BaseMarkdownRendererProps = {
+    /**
+     * The HTML tag used for the rendered markdown container.
+     *
+     * Defaults to `'article'`.
+     */
+    as?: keyof JSX.IntrinsicElements;
+    /**
+     * Content rendered when the markdown input is empty or missing.
+     */
+    emptyFallback?: ReactNode;
+    /**
+     * Content rendered when markdown compilation fails and a fallback is desired.
+     */
+    errorFallback?: ReactNode;
+    /**
+     * The markdown source string to render.
+     */
+    markdown?: null | string;
+};
+/**
+ * Props for the main markdown renderer component.
+ *
+ * This merges persisted/configurable markdown presentation settings with the
+ * runtime-only rendering props required by the component itself.
+ */
+export type MarkdownRendererProps = {
+    collectionSlug?: string;
+    scope?: MarkdownRendererScope;
+} & BaseMarkdownRendererProps & MarkdownRenderConfig;
+/**
+ * Options available while rendering an individual fenced code block.
+ */
+export interface CodeBlockOptions extends RenderMarkdownOptions {
+    /**
+     * The parsed language identifier for the fenced code block, if present.
+     */
+    lang?: string;
+}
+/**
+ * Stored Payload block data for a markdown block instance.
+ */
+export interface MarkdownBlockData {
+    /**
+     * Optional block display name assigned by Payload.
+     */
+    blockName?: null | string;
+    /**
+     * The Payload block slug.
+     */
+    blockType: 'vlMdBlock';
+    /**
+     * Markdown source content for this block.
+     */
+    content: string;
+    /**
+     * Optional Payload-generated block identifier.
+     */
+    id?: null | string;
+}
+/**
+ * Props for the markdown block component wrapper.
+ */
+export interface MarkdownBlockProps extends MarkdownBlockData {
+    /**
+     * The slug of the collection this block is rendered within, if applicable.
+     */
+    collectionSlug?: string;
+}

package/dist/types/core.js

@@ -0,0 +1,5 @@
+/**
+ * Props for the markdown block component wrapper.
+ */ export { };
+
+//# sourceMappingURL=core.js.map

package/dist/types/core.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/core.ts"],"sourcesContent":["import type { JSX, ReactNode } from 'react'\n\nexport type MarkdownRendererScope = 'blocks' | 'field'\n\n/**\n * Options that control how fenced code blocks are rendered inside markdown content.\n *\n * By default, code blocks use the plugin's enhanced rendering mode:\n * - `enhancedCodeBlocks` defaults to `true`\n * - `lineNumbers` defaults to `true`\n * - `theme` defaults to `'github-dark'`\n *\n * When enhanced rendering is enabled, the plugin applies its normalized code block\n * pipeline on top of Shiki output. This includes layout cleanup, background\n * normalization, and support for features like line numbers.\n *\n * When enhanced rendering is disabled, code blocks are rendered closer to raw\n * Shiki output and plugin-specific enhancements are bypassed.\n *\n * These options are passed through the markdown rendering pipeline and primarily\n * affect Shiki-rendered code fences.\n */\nexport type RenderMarkdownOptions = {\n  /**\n   * Whether to apply the plugin's enhanced code block rendering pipeline.\n   *\n   * Defaults to `true`.\n   *\n   * When enabled, the renderer performs structural and visual normalization on\n   * Shiki output to produce a consistent, content-focused appearance.\n   *\n   * When disabled, code blocks are rendered closer to raw Shiki output.\n   */\n  enhancedCodeBlocks?: boolean\n\n  /**\n   * An optional list of language identifiers to load for Shiki syntax highlighting.\n   *\n   * By default, the plugin loads a core set of popular languages. You can replace\n   * that set entirely or extend it using spread syntax:\n   *\n   * ```ts\n   * options: {\n   *   langs: [...DEFAULT_CODE_LANGS, 'latex']\n   * }\n   * ```\n   */\n  langs?: string[]\n\n  /**\n   * Whether to show line numbers for fenced code blocks.\n   *\n   * Defaults to `true` when `enhancedCodeBlocks` is enabled.\n   *\n   * Line numbers require the enhanced rendering pipeline and are automatically\n   * disabled when `enhancedCodeBlocks` is set to `false`.\n   */\n  lineNumbers?: boolean\n\n  /**\n   * The Shiki theme to use for syntax highlighting.\n   *\n   * Defaults to `'github-dark'`.\n   *\n   * The plugin's enhanced renderer is tuned around its default theme. When using a\n   * non-default theme:\n   *\n   * - `enhancedCodeBlocks: true` opts into the plugin's normalized rendering pipeline\n   * - `enhancedCodeBlocks: false` preserves the theme's native appearance more closely\n   *\n   * This allows you to choose between a more controlled presentation and a more\n   * theme-faithful rendering mode.\n   */\n  theme?: string\n}\n\nexport type MarkdownCodeConfig = {\n  /**\n   * Whether to apply the plugin's enhanced code block rendering pipeline.\n   */\n  enhanced?: boolean\n\n  /**\n   * Whether fenced code blocks should extend beyond the normal content width\n   * on larger screens.\n   */\n  fullBleed?: boolean\n\n  /**\n   * Optional list of language identifiers to load for Shiki syntax highlighting.\n   */\n  langs?: string[]\n\n  /**\n   * Whether to show line numbers for fenced code blocks.\n   */\n  lineNumbers?: boolean\n\n  /**\n   * The Shiki theme to use for syntax highlighting.\n   */\n  shikiTheme?: string\n}\n\nexport type MarkdownDirectiveTheme = {\n  classes: string\n  label?: string\n  name: string\n}\n\nexport type MarkdownDirectiveThemeGroup = {\n  extendDefaults?: boolean\n  items?: MarkdownDirectiveTheme[]\n} | MarkdownDirectiveTheme[]\n\nexport type MarkdownDirectiveThemes = {\n  callout?: MarkdownDirectiveThemeGroup\n  card?: MarkdownDirectiveThemeGroup\n  cards?: MarkdownDirectiveThemeGroup\n  cell?: MarkdownDirectiveThemeGroup\n  columns?: MarkdownDirectiveThemeGroup\n  details?: MarkdownDirectiveThemeGroup\n  section?: MarkdownDirectiveThemeGroup\n  steps?: MarkdownDirectiveThemeGroup\n  tab?: MarkdownDirectiveThemeGroup\n  tabs?: MarkdownDirectiveThemeGroup\n  toc?: MarkdownDirectiveThemeGroup\n}\n\n/**\n * The result of compiling markdown into sanitized HTML.\n */\nexport type RenderMarkdownResult = {\n  /**\n   * The rendered HTML output.\n   */\n  html: string\n\n  /**\n   * Non-fatal warnings produced during rendering.\n   */\n  warnings: string[]\n}\n\n/**\n * Preset visual styles for rendered markdown content.\n */\nexport type MarkdownVariant = 'blog' | 'compact' | 'docs' | 'unstyled'\n\n/**\n * Preset typography sizes for rendered markdown content.\n */\nexport type MarkdownSize = 'lg' | 'md' | 'sm'\n\n/**\n * Core markdown presentation configuration.\n *\n * This type represents the configurable styling and behavior layer that can be\n * sourced from plugin defaults, globals, collection defaults, or block-level\n * overrides. It intentionally excludes runtime-only renderer props such as\n * `markdown`, `as`, and fallback nodes.\n */\nexport type MarkdownConfig = {\n  /**\n   * Additional classes applied to the rendered markdown element itself.\n   */\n  className?: string\n\n  /**\n   * Additional classes applied to column elements within the rendered markdown, if applicable.\n   *\n   * @deprecated Use directive themes instead.\n   */\n  columnClassName?: string\n\n  /**\n   * Whether to apply horizontal gutter padding to the outer wrapper.\n   *\n   * Defaults to `false`.\n   */\n  enableGutter?: boolean\n\n  /**\n   * Whether fenced code blocks should extend beyond the normal content width\n   * on larger screens.\n   *\n   * Defaults to `false`.\n   *\n   * @deprecated Use top-level or renderer-level `code.fullBleed` instead.\n   */\n  fullBleedCode?: boolean\n\n  /**\n   * Optional content rendered above the markdown body.\n   */\n  lead?: ReactNode\n\n  /**\n   * Whether heading colors should be slightly muted.\n   *\n   * Defaults to `false`.\n   */\n  mutedHeadings?: boolean\n\n  /**\n   * Options that control fenced code block rendering.\n   *\n   * @deprecated Use top-level or renderer-level `code` instead.\n   */\n  options?: RenderMarkdownOptions\n\n  /**\n   * Additional classes applied to section elements within the rendered markdown, if applicable.\n   *\n   * @deprecated Use directive themes instead.\n   */\n  sectionClassName?: string\n\n  /**\n   * Typography size preset for the rendered markdown.\n   *\n   * Defaults to `'lg'`.\n   */\n  size?: MarkdownSize\n\n  /**\n   * Visual style preset for the rendered markdown.\n   *\n   * Defaults to `'blog'`.\n   */\n  variant?: MarkdownVariant\n\n  /**\n   * Additional classes applied to the outer wrapper element.\n   */\n  wrapperClassName?: string\n}\n\nexport type MarkdownRenderConfig = {\n  code?: MarkdownCodeConfig\n  themes?: MarkdownDirectiveThemes\n} & MarkdownConfig\n\n/**\n * Runtime-only props shared by markdown renderer components.\n */\nexport type BaseMarkdownRendererProps = {\n  /**\n   * The HTML tag used for the rendered markdown container.\n   *\n   * Defaults to `'article'`.\n   */\n  as?: keyof JSX.IntrinsicElements\n\n  /**\n   * Content rendered when the markdown input is empty or missing.\n   */\n  emptyFallback?: ReactNode\n\n  /**\n   * Content rendered when markdown compilation fails and a fallback is desired.\n   */\n  errorFallback?: ReactNode\n\n  /**\n   * The markdown source string to render.\n   */\n  markdown?: null | string\n}\n\n/**\n * Props for the main markdown renderer component.\n *\n * This merges persisted/configurable markdown presentation settings with the\n * runtime-only rendering props required by the component itself.\n */\nexport type MarkdownRendererProps = {\n  collectionSlug?: string\n  scope?: MarkdownRendererScope\n} & BaseMarkdownRendererProps & MarkdownRenderConfig\n\n/**\n * Options available while rendering an individual fenced code block.\n */\nexport interface CodeBlockOptions extends RenderMarkdownOptions {\n  /**\n   * The parsed language identifier for the fenced code block, if present.\n   */\n  lang?: string\n}\n\n/**\n * Stored Payload block data for a markdown block instance.\n */\nexport interface MarkdownBlockData {\n  /**\n   * Optional block display name assigned by Payload.\n   */\n  blockName?: null | string\n\n  /**\n   * The Payload block slug.\n   */\n  blockType: 'vlMdBlock'\n\n  /**\n   * Markdown source content for this block.\n   */\n  content: string\n\n  /**\n   * Optional Payload-generated block identifier.\n   */\n  id?: null | string\n}\n\n/**\n * Props for the markdown block component wrapper.\n */\nexport interface MarkdownBlockProps extends MarkdownBlockData {\n  /**\n   * The slug of the collection this block is rendered within, if applicable.\n   */\n  collectionSlug?: string\n}\n"],"names":[],"mappings":"AA4TA;;CAEC,GACD,WAKC"}

package/dist/types/layoutToken.d.ts

@@ -0,0 +1 @@
+export type { LayoutName, LayoutToken } from '../directives/types.js';

package/dist/types/layoutToken.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=layoutToken.js.map

package/dist/types/layoutToken.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/layoutToken.ts"],"sourcesContent":["export type { LayoutName, LayoutToken } from '../directives/types.js'\n"],"names":[],"mappings":"AAAA,WAAqE"}

package/dist/types/mdast.d.js

@@ -0,0 +1,5 @@
+/**
+ * @import {} from 'mdast-util-directive'
+ */ import 'mdast-util-directive';
+
+//# sourceMappingURL=mdast.d.js.map

package/dist/types/mdast.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/mdast.d.ts"],"sourcesContent":["/**\n * @import {} from 'mdast-util-directive'\n */\n\nimport 'mdast-util-directive'\n\nimport type { LayoutToken } from './layoutToken'\n\ndeclare module 'mdast-util-directive' {\n  interface ContainerDirectiveData {\n    vlCellHeadingDepth?: number\n    vlParentHeadingDepth?: number\n  }\n}\n\ndeclare module 'mdast' {\n  interface RootContentMap {\n    vlLayoutToken: LayoutToken\n  }\n}\n"],"names":[],"mappings":"AAAA;;CAEC,GAED,OAAO,uBAAsB"}

package/dist/types.d.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=types.d.js.map

package/dist/types.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["import type { CollectionSlug } from 'payload'\n\nimport type { MarkdownConfig } from './core/types.d.js'\n\nexport type DualMarkdownFieldConfig = {\n  blocks?: MarkdownConfig\n  field?: MarkdownConfig\n}\n\nexport type ConfigOptions = DualMarkdownFieldConfig | MarkdownConfig\n\nexport type PayloadMarkdownCollectionConfig = {\n  /**\n   * Styling options for markdown fields added to the collection, and/or markdown fields added within blocks to the collection.\n   */\n  config?: ConfigOptions\n\n  /**\n   * Options for the markdown field.\n   */\n  field?: Omit<MarkdownFieldOptions, 'name'>\n\n  /**\n   * The name of the markdown field to add to the collection. Defaults to 'content'.\n   */\n  fieldName?: string\n\n  /**\n   * Whether to add a standalone markdown field to the collection.\n   *\n   * If not specified, this is inferred automatically:\n   * - `true` when the collection does not contain any `blocks` fields\n   * - `false` when the collection does contain `blocks` fields\n   */\n  installField?: boolean\n\n  /**\n   * Whether to install the markdown block into any `blocks` fields in the collection.\n   *\n   * If not specified, this is inferred automatically:\n   * - `true` when the collection contains one or more `blocks` fields\n   * - `false` when the collection does not contain any `blocks` fields\n   *\n   * Note: You must still add the MarkdownBlockComponent to your RenderBlocks.tsx\n   * or equivalent for the block to render properly.\n   */\n  installIntoBlocks?: boolean\n}\n\nexport interface PayloadMarkdownConfig {\n  /**\n   * Add markdown field to collections.\n   * Set to `true` to add a field with default options, or an object to configure the field.\n   */\n  collections?: Partial<Record<CollectionSlug, PayloadMarkdownCollectionConfig | true>>\n\n  /**\n   * Add a global for markdown block settings, which can be used to provide default configuration values for all markdown in the project.\n   */\n  config?: ConfigOptions\n\n  /**\n   * Enable or disable plugin\n   * @default false\n   */\n  enabled?: boolean\n}\n"],"names":[],"mappings":"AAiDA,WAiBC"}

package/dist/types.d.ts

@@ -0,0 +1,80 @@
+import type { CollectionSlug, TextField } from 'payload';
+import type { MarkdownCodeConfig, MarkdownConfig, MarkdownDirectiveThemes } from './types/core.js';
+export type DualMarkdownFieldConfig = {
+    blocks?: MarkdownConfig;
+    field?: MarkdownConfig;
+};
+export type ConfigOptions = DualMarkdownFieldConfig | MarkdownConfig;
+export type MarkdownFieldOptions = {
+    admin?: Partial<TextField['admin']>;
+    defaultValue?: string;
+    label?: string;
+    localized?: boolean;
+    name?: string;
+    required?: boolean;
+};
+export type PayloadMarkdownCollectionConfig = {
+    /**
+     * Code fence / Shiki rendering options for markdown in this collection.
+     */
+    code?: MarkdownCodeConfig;
+    /**
+     * Styling options for markdown fields added to the collection, and/or markdown fields added within blocks to the collection.
+     */
+    config?: ConfigOptions;
+    /**
+     * Options for the markdown field.
+     */
+    field?: Omit<MarkdownFieldOptions, 'name'>;
+    /**
+     * The name of the markdown field to add to the collection. Defaults to 'content'.
+     */
+    fieldName?: string;
+    /**
+     * Whether to add a standalone markdown field to the collection.
+     *
+     * If not specified, this is inferred automatically:
+     * - `true` when the collection does not contain any `blocks` fields
+     * - `false` when the collection does contain `blocks` fields
+     */
+    installField?: boolean;
+    /**
+     * Whether to install the markdown block into any `blocks` fields in the collection.
+     *
+     * If not specified, this is inferred automatically:
+     * - `true` when the collection contains one or more `blocks` fields
+     * - `false` when the collection does not contain any `blocks` fields
+     *
+     * Note: You must still add the MarkdownBlockComponent to your RenderBlocks.tsx
+     * or equivalent for the block to render properly.
+     */
+    installIntoBlocks?: boolean;
+    /**
+     * Directive theme registry extensions for markdown in this collection.
+     */
+    themes?: MarkdownDirectiveThemes;
+};
+export interface PayloadMarkdownConfig {
+    /**
+     * Code fence / Shiki rendering options.
+     */
+    code?: MarkdownCodeConfig;
+    /**
+     * Add markdown field to collections.
+     * Set to `true` to add a field with default options, or an object to configure the field.
+     */
+    collections?: Partial<Record<CollectionSlug, PayloadMarkdownCollectionConfig | true>>;
+    /**
+     * Add a global for markdown block settings, which can be used to provide default configuration values for all markdown in the project.
+     */
+    config?: ConfigOptions;
+    /**
+     * Enable or disable plugin
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Directive theme registry extensions.
+     */
+    themes?: MarkdownDirectiveThemes;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { CollectionSlug, TextField } from 'payload'\n\nimport type { MarkdownCodeConfig, MarkdownConfig, MarkdownDirectiveThemes } from './types/core.js'\n\nexport type DualMarkdownFieldConfig = {\n  blocks?: MarkdownConfig\n  field?: MarkdownConfig\n}\n\nexport type ConfigOptions = DualMarkdownFieldConfig | MarkdownConfig\n\nexport type MarkdownFieldOptions = {\n  admin?: Partial<TextField['admin']>\n  defaultValue?: string\n  label?: string\n  localized?: boolean\n  name?: string\n  required?: boolean\n}\n\nexport type PayloadMarkdownCollectionConfig = {\n  /**\n   * Code fence / Shiki rendering options for markdown in this collection.\n   */\n  code?: MarkdownCodeConfig\n\n  /**\n   * Styling options for markdown fields added to the collection, and/or markdown fields added within blocks to the collection.\n   */\n  config?: ConfigOptions\n\n  /**\n   * Options for the markdown field.\n   */\n  field?: Omit<MarkdownFieldOptions, 'name'>\n\n  /**\n   * The name of the markdown field to add to the collection. Defaults to 'content'.\n   */\n  fieldName?: string\n\n  /**\n   * Whether to add a standalone markdown field to the collection.\n   *\n   * If not specified, this is inferred automatically:\n   * - `true` when the collection does not contain any `blocks` fields\n   * - `false` when the collection does contain `blocks` fields\n   */\n  installField?: boolean\n\n  /**\n   * Whether to install the markdown block into any `blocks` fields in the collection.\n   *\n   * If not specified, this is inferred automatically:\n   * - `true` when the collection contains one or more `blocks` fields\n   * - `false` when the collection does not contain any `blocks` fields\n   *\n   * Note: You must still add the MarkdownBlockComponent to your RenderBlocks.tsx\n   * or equivalent for the block to render properly.\n   */\n  installIntoBlocks?: boolean\n\n  /**\n   * Directive theme registry extensions for markdown in this collection.\n   */\n  themes?: MarkdownDirectiveThemes\n}\n\nexport interface PayloadMarkdownConfig {\n  /**\n   * Code fence / Shiki rendering options.\n   */\n  code?: MarkdownCodeConfig\n\n  /**\n   * Add markdown field to collections.\n   * Set to `true` to add a field with default options, or an object to configure the field.\n   */\n  collections?: Partial<Record<CollectionSlug, PayloadMarkdownCollectionConfig | true>>\n\n  /**\n   * Add a global for markdown block settings, which can be used to provide default configuration values for all markdown in the project.\n   */\n  config?: ConfigOptions\n\n  /**\n   * Enable or disable plugin\n   * @default false\n   */\n  enabled?: boolean\n\n  /**\n   * Directive theme registry extensions.\n   */\n  themes?: MarkdownDirectiveThemes\n}\n"],"names":[],"mappings":"AAoEA,WA2BC"}

package/package.json

@@ -0,0 +1,181 @@
+{
+  "name": "@valkyrianlabs/payload-markdown",
+  "version": "1.3.1",
+  "description": "Structured Markdown editing and rendering for Payload CMS with CodeMirror, Shiki, directives, themes, and server-first output.",
+  "repository": {
+    "url": "https://github.com/valkyrianlabs/payload-markdown"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "import": "./dist/exports/client.js",
+      "types": "./dist/exports/client.d.ts",
+      "default": "./dist/exports/client.js"
+    },
+    "./server": {
+      "import": "./dist/exports/server.js",
+      "types": "./dist/exports/server.d.ts",
+      "default": "./dist/exports/server.js"
+    },
+    "./advanced": {
+      "import": "./dist/exports/advanced.js",
+      "types": "./dist/exports/advanced.d.ts",
+      "default": "./dist/exports/advanced.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc --outDir dist --rootDir ./src",
+    "clean": "rimraf {dist,*.tsbuildinfo}",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
+    "dev": "next dev dev --turbo --no-server-fast-refresh",
+    "dev:generate-importmap": "pnpm dev:payload generate:importmap",
+    "dev:generate-types": "pnpm dev:payload generate:types",
+    "dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
+    "generate:importmap": "pnpm dev:generate-importmap",
+    "generate:types": "pnpm dev:generate-types",
+    "lint": "eslint",
+    "lint:fix": "eslint ./src --fix",
+    "test": "pnpm test:int && pnpm test:e2e",
+    "test:e2e": "playwright test",
+    "test:int": "vitest"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.5",
+    "@payloadcms/db-mongodb": "latest",
+    "@payloadcms/db-postgres": "latest",
+    "@payloadcms/db-sqlite": "latest",
+    "@payloadcms/eslint-config": "latest",
+    "@payloadcms/live-preview-react": "latest",
+    "@payloadcms/next": "latest",
+    "@payloadcms/richtext-lexical": "latest",
+    "@payloadcms/ui": "latest",
+    "@playwright/test": "1.58.2",
+    "@swc-node/register": "1.10.9",
+    "@swc/cli": "0.6.0",
+    "@tailwindcss/postcss": "^4.2.4",
+    "@tailwindcss/typography": "^0.5.19",
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "22.19.9",
+    "@types/react": "19.2.14",
+    "@types/react-dom": "19.2.3",
+    "@types/unist": "^3.0.3",
+    "copyfiles": "2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.39.4",
+    "eslint-config-next": "16.2.1",
+    "graphql": "^16.13.2",
+    "mongodb-memory-server": "10.1.4",
+    "next": "^16.2.4",
+    "open": "^10.2.0",
+    "payload": "latest",
+    "postcss": "^8.5.12",
+    "prettier": "^3.8.3",
+    "qs-esm": "7.0.2",
+    "react": "19.2.4",
+    "react-dom": "19.2.4",
+    "rimraf": "3.0.2",
+    "sharp": "0.34.2",
+    "sort-package-json": "^2.15.1",
+    "tailwindcss": "^4.2.4",
+    "typescript": "5.7.3",
+    "vite-tsconfig-paths": "6.0.5",
+    "vitest": "4.0.18"
+  },
+  "peerDependencies": {
+    "payload": "^3.0.0"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0",
+    "pnpm": "^9 || ^10"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": {
+        "import": "./dist/index.js",
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "./client": {
+        "import": "./dist/exports/client.js",
+        "types": "./dist/exports/client.d.ts",
+        "default": "./dist/exports/client.js"
+      },
+      "./server": {
+        "import": "./dist/exports/server.js",
+        "types": "./dist/exports/server.d.ts",
+        "default": "./dist/exports/server.js"
+      },
+      "./advanced": {
+        "import": "./dist/exports/advanced.js",
+        "types": "./dist/exports/advanced.d.ts",
+        "default": "./dist/exports/advanced.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "@swc/core",
+      "esbuild",
+      "mongodb-memory-server",
+      "sharp",
+      "unrs-resolver"
+    ]
+  },
+  "registry": "https://registry.npmjs.org/",
+  "dependencies": {
+    "@codemirror/autocomplete": "^6.20.1",
+    "@codemirror/commands": "^6.10.3",
+    "@codemirror/lang-angular": "^0.1.4",
+    "@codemirror/lang-cpp": "^6.0.3",
+    "@codemirror/lang-css": "^6.3.1",
+    "@codemirror/lang-go": "^6.0.1",
+    "@codemirror/lang-html": "^6.4.11",
+    "@codemirror/lang-java": "^6.0.2",
+    "@codemirror/lang-javascript": "^6.2.5",
+    "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/lang-markdown": "^6.5.0",
+    "@codemirror/lang-php": "^6.0.2",
+    "@codemirror/lang-python": "^6.2.1",
+    "@codemirror/lang-rust": "^6.0.2",
+    "@codemirror/lang-sass": "^6.0.2",
+    "@codemirror/lang-sql": "^6.10.0",
+    "@codemirror/lang-vue": "^0.1.3",
+    "@codemirror/lang-xml": "^6.1.0",
+    "@codemirror/lang-yaml": "^6.1.3",
+    "@codemirror/language": "^6.12.3",
+    "@codemirror/lint": "^6.9.5",
+    "@codemirror/state": "^6.6.0",
+    "@codemirror/view": "^6.41.1",
+    "@lezer/highlight": "^1.2.3",
+    "hast-util-from-html": "^2.0.3",
+    "hast-util-sanitize": "^5.0.2",
+    "hast-util-to-string": "^3.0.1",
+    "mdast-util-directive": "^3.1.0",
+    "rehype-raw": "^7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "shiki": "^4.0.2",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0"
+  },
+  "packageManager": "pnpm@10.33.0"
+}