types

Type Aliases

AstroMarkdownOptions

type AstroMarkdownOptions = {
  flavor: "astro";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
};

Defined in: studiocms/packages/@studiocms/md/src/types.ts:82^

Schema definition for Astro-flavored Markdown content.

Type Declaration

flavor

flavor: "astro";

Specifies the Markdown flavor, fixed to ‘astro’. This property is used to differentiate between different Markdown configurations.

sanitize?

optional sanitize: {
  allowAttributes?: Record<string, string[]>;
  allowComments?: boolean;
  allowComponents?: boolean;
  allowCustomElements?: boolean;
  allowElements?: string[];
  blockElements?: string[];
  dropAttributes?: Record<string, string[]>;
  dropElements?: string[];
} = StudioCMSSanitizeOptionsSchema;

Schema for options used to sanitize Markdown content in StudioCMS.

Remarks

This schema defines the configuration for controlling which elements and attributes are allowed, blocked, or dropped during the sanitization process. It also provides options for handling components, custom elements, and comments.

sanitize.allowAttributes?

optional allowAttributes: Record<string, string[]>;

sanitize.allowComments?

optional allowComments: boolean;

sanitize.allowComponents?

optional allowComponents: boolean;

sanitize.allowCustomElements?

optional allowCustomElements: boolean;

sanitize.allowElements?

optional allowElements: string[];

sanitize.blockElements?

optional blockElements: string[];

sanitize.dropAttributes?

optional dropAttributes: Record<string, string[]>;

sanitize.dropElements?

optional dropElements: string[];

Remarks

This schema is used to validate Markdown objects that are specifically intended for use with the Astro flavor. It ensures that the flavor property is set to 'astro' and that the sanitize property conforms to the StudioCMSSanitizeOptionsSchema.

MarkdownSchemaOptions

type MarkdownSchemaOptions =
  | {
  flavor: "astro";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
}
  | {
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  flavor: "studiocms";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
};

Defined in: studiocms/packages/@studiocms/md/src/types.ts:84^

Defines a Zod schema for Markdown content, allowing either AstroMarkdownSchema or StudioCMSMarkdownSchema. The schema is optional and defaults to an object with the flavor set to ‘studiocms’.

Type Declaration

{
  flavor: "astro";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
}

flavor

flavor: "astro";

Specifies the Markdown flavor, fixed to ‘astro’. This property is used to differentiate between different Markdown configurations.

sanitize?

optional sanitize: {
  allowAttributes?: Record<string, string[]>;
  allowComments?: boolean;
  allowComponents?: boolean;
  allowCustomElements?: boolean;
  allowElements?: string[];
  blockElements?: string[];
  dropAttributes?: Record<string, string[]>;
  dropElements?: string[];
} = StudioCMSSanitizeOptionsSchema;

Schema for options used to sanitize Markdown content in StudioCMS.

Remarks

sanitize.allowAttributes?

optional allowAttributes: Record<string, string[]>;

sanitize.allowComments?

optional allowComments: boolean;

sanitize.allowComponents?

optional allowComponents: boolean;

sanitize.allowCustomElements?

optional allowCustomElements: boolean;

sanitize.allowElements?

optional allowElements: string[];

sanitize.blockElements?

optional blockElements: string[];

sanitize.dropAttributes?

optional dropAttributes: Record<string, string[]>;

sanitize.dropElements?

optional dropElements: string[];

{
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  flavor: "studiocms";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
}

autoLinkHeadings

autoLinkHeadings: boolean;

Optionally enables automatic linking of headings, defaults to true. This property allows users to automatically create links for headings in Markdown content.

callouts

callouts: false | "github" | "obsidian" | "vitepress";

Optional callouts style, defaults to ‘obsidian’. This property allows users to choose a specific callout theme for Markdown content.

discordSubtext

discordSubtext: boolean;

Optionally enables Discord subtext, defaults to true. This property allows users to include Discord-style subtext in Markdown content.

flavor

flavor: "studiocms";

Specifies the markdown flavor, fixed to ‘studiocms’. This property is used to differentiate between different Markdown configurations.

sanitize?

optional sanitize: {
  allowAttributes?: Record<string, string[]>;
  allowComments?: boolean;
  allowComponents?: boolean;
  allowCustomElements?: boolean;
  allowElements?: string[];
  blockElements?: string[];
  dropAttributes?: Record<string, string[]>;
  dropElements?: string[];
} = StudioCMSSanitizeOptionsSchema;

Schema for options used to sanitize Markdown content in StudioCMS.

Remarks

sanitize.allowAttributes?

optional allowAttributes: Record<string, string[]>;

sanitize.allowComments?

optional allowComments: boolean;

sanitize.allowComponents?

optional allowComponents: boolean;

sanitize.allowCustomElements?

optional allowCustomElements: boolean;

sanitize.allowElements?

optional allowElements: string[];

sanitize.blockElements?

optional blockElements: string[];

sanitize.dropAttributes?

optional dropAttributes: Record<string, string[]>;

sanitize.dropElements?

optional dropElements: string[];

Remarks

This schema is useful for validating Markdown data that may conform to different formats, providing flexibility in content handling within the application.

StudioCMSMarkdownOptions

type StudioCMSMarkdownOptions = {
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  flavor: "studiocms";
  sanitize?: {
     allowAttributes?: Record<string, string[]>;
     allowComments?: boolean;
     allowComponents?: boolean;
     allowCustomElements?: boolean;
     allowElements?: string[];
     blockElements?: string[];
     dropAttributes?: Record<string, string[]>;
     dropElements?: string[];
  };
};

Defined in: studiocms/packages/@studiocms/md/src/types.ts:83^

Schema definition for StudioCMS Markdown configuration.

Type Declaration

autoLinkHeadings

autoLinkHeadings: boolean;

Optionally enables automatic linking of headings, defaults to true. This property allows users to automatically create links for headings in Markdown content.

callouts

callouts: false | "github" | "obsidian" | "vitepress";

Optional callouts style, defaults to ‘obsidian’. This property allows users to choose a specific callout theme for Markdown content.

discordSubtext

discordSubtext: boolean;

Optionally enables Discord subtext, defaults to true. This property allows users to include Discord-style subtext in Markdown content.

flavor

flavor: "studiocms";

Specifies the markdown flavor, fixed to ‘studiocms’. This property is used to differentiate between different Markdown configurations.

sanitize?

optional sanitize: {
  allowAttributes?: Record<string, string[]>;
  allowComments?: boolean;
  allowComponents?: boolean;
  allowCustomElements?: boolean;
  allowElements?: string[];
  blockElements?: string[];
  dropAttributes?: Record<string, string[]>;
  dropElements?: string[];
} = StudioCMSSanitizeOptionsSchema;

Schema for options used to sanitize Markdown content in StudioCMS.

Remarks

sanitize.allowAttributes?

optional allowAttributes: Record<string, string[]>;

sanitize.allowComments?

optional allowComments: boolean;

sanitize.allowComponents?

optional allowComponents: boolean;

sanitize.allowCustomElements?

optional allowCustomElements: boolean;

sanitize.allowElements?

optional allowElements: string[];

sanitize.blockElements?

optional blockElements: string[];

sanitize.dropAttributes?

optional dropAttributes: Record<string, string[]>;

sanitize.dropElements?

optional dropElements: string[];

Variables

AstroMarkdownSchema

const AstroMarkdownSchema: ZodObject<AstroMarkdownOptions>;

Defined in: studiocms/packages/@studiocms/md/src/types.ts:17^

Schema definition for Astro-flavored Markdown content.

Remarks

MarkdownSchema

const MarkdownSchema: ZodDefault<MarkdownSchemaOptions>;

Defined in: studiocms/packages/@studiocms/md/src/types.ts:77^

Defines a Zod schema for Markdown content, allowing either AstroMarkdownSchema or StudioCMSMarkdownSchema. The schema is optional and defaults to an object with the flavor set to ‘studiocms’.

Remarks

This schema is useful for validating Markdown data that may conform to different formats, providing flexibility in content handling within the application.

StudioCMSMarkdownSchema

const StudioCMSMarkdownSchema: ZodObject<StudioCMSMarkdownOptions>;

Defined in: studiocms/packages/@studiocms/md/src/types.ts:43^

Schema definition for StudioCMS Markdown configuration.