lib/renderer/types

Interfaces

'Read the “', Interfaces, '” section'

Shared

'Read the “', Shared, '” section'

Defined in: studiocms/packages/studiocms/src/lib/renderer/types.ts:12

Interface representing shared configuration for markdown.

Shared

Properties

'Read the “', Properties, '” section'

astroMDRemark

'Read the “', astroMDRemark, '” section'

astroMDRemark:
  | undefined
  | {
  gfm: boolean;
  rehypePlugins: (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
  remarkPlugins: (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
  remarkRehype: RemarkRehype;
  shikiConfig: {
     defaultColor: string | false;
     langAlias: Record<string, string>;
     langs: ShikiLang[];
     theme: BundledTheme | ShikiTheme;
     themes: Record<string, BundledTheme | ShikiTheme>;
     transformers: ShikiTransformer[];
     wrap: null | boolean;
    };
  smartypants: boolean;
  syntaxHighlight:   | false
     | "shiki"
     | "prism"
     | {
     excludeLangs: string[];
     type: "shiki" | "prism";
    };
};

Defined in: studiocms/packages/studiocms/src/lib/renderer/types.ts:13

studiocmsHTML

'Read the “', studiocmsHTML, '” section'

studiocmsHTML:
  | undefined
  | {
  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/src/lib/renderer/types.ts:15

studiocmsMarkdown

'Read the “', studiocmsMarkdown, '” section'

studiocmsMarkdown:
  | undefined
  | {
  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/src/lib/renderer/types.ts:14