Aller au contenu
StudioCMS Docs
Site principal
Démo

schemas/config/pageTypeOptions

Ce contenu n’est pas encore disponible dans votre langue.

Type Aliases

'Read the “', Type Aliases, '” section'

HTMLSchemaOptions

'Read the “', HTMLSchemaOptions, '” section'
type HTMLSchemaOptions = z.infer<typeof HTMLSchema>;

Defined in: studiocms/packages/studiocms/src/schemas/config/pageTypeOptions.ts:62

MarkdownSchemaOptions

'Read the “', MarkdownSchemaOptions, '” section'
type MarkdownSchemaOptions = z.infer<typeof MarkdownSchema>;

Defined in: studiocms/packages/studiocms/src/schemas/config/pageTypeOptions.ts:61

StudioCMSMarkdownOptions

'Read the “', StudioCMSMarkdownOptions, '” section'
type StudioCMSMarkdownOptions = z.infer<typeof StudioCMSMarkdownSchema>;

Defined in: studiocms/packages/studiocms/src/schemas/config/pageTypeOptions.ts:60

Variables

'Read the “', Variables, '” section'

AstroMarkdownSchema

'Read the “', AstroMarkdownSchema, '” section'
const AstroMarkdownSchema: ZodObject<{
  flavor: ZodLiteral<"astro">;
  sanitize: ZodOptional<ZodObject<{
     allowAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     allowComments: ZodOptional<ZodBoolean>;
     allowComponents: ZodOptional<ZodBoolean>;
     allowCustomElements: ZodOptional<ZodBoolean>;
     allowElements: ZodOptional<ZodArray<ZodString, "many">>;
     blockElements: ZodOptional<ZodArray<ZodString, "many">>;
     dropAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     dropElements: ZodOptional<ZodArray<ZodString, "many">>;
    }, "strip", ZodTypeAny, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }>>;
 }, "strip", ZodTypeAny, {
  flavor: "astro";
  sanitize: {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    };
 }, {
  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/src/schemas/config/pageTypeOptions.ts:24

BuiltInPageTypeOptionsSchema

'Read the “', BuiltInPageTypeOptionsSchema, '” section'
const BuiltInPageTypeOptionsSchema: ZodDefault<ZodOptional<ZodObject<{
  html: ZodDefault<ZodOptional<ZodObject<{
     sanitize: ZodOptional<ZodObject<{
        allowAttributes: ...;
        allowComments: ...;
        allowComponents: ...;
        allowCustomElements: ...;
        allowElements: ...;
        blockElements: ...;
        dropAttributes: ...;
        dropElements: ...;
       }, "strip", ZodTypeAny, {
        allowAttributes: ...;
        allowComments: ...;
        allowComponents: ...;
        allowCustomElements: ...;
        allowElements: ...;
        blockElements: ...;
        dropAttributes: ...;
        dropElements: ...;
       }, {
        allowAttributes: ...;
        allowComments: ...;
        allowComponents: ...;
        allowCustomElements: ...;
        allowElements: ...;
        blockElements: ...;
        dropAttributes: ...;
        dropElements: ...;
       }>>;
    }, "strip", ZodTypeAny, {
     sanitize: {
        allowAttributes: ... | ...;
        allowComments: ... | ... | ...;
        allowComponents: ... | ... | ...;
        allowCustomElements: ... | ... | ...;
        allowElements: ... | ...;
        blockElements: ... | ...;
        dropAttributes: ... | ...;
        dropElements: ... | ...;
       };
    }, {
     sanitize: {
        allowAttributes: ... | ...;
        allowComments: ... | ... | ...;
        allowComponents: ... | ... | ...;
        allowCustomElements: ... | ... | ...;
        allowElements: ... | ...;
        blockElements: ... | ...;
        dropAttributes: ... | ...;
        dropElements: ... | ...;
       };
    }>>>;
  markdown: ZodDefault<ZodOptional<ZodUnion<[ZodObject<{
     flavor: ZodLiteral<...>;
     sanitize: ZodOptional<...>;
    }, "strip", ZodTypeAny, {
     flavor: "astro";
     sanitize: ... | ...;
    }, {
     flavor: "astro";
     sanitize: ... | ...;
    }>, ZodObject<extendShape<{
     flavor: ...;
     sanitize: ...;
    }, {
     autoLinkHeadings: ...;
     callouts: ...;
     discordSubtext: ...;
     flavor: ...;
    }>, "strip", ZodTypeAny, {
     autoLinkHeadings: boolean;
     callouts: ... | ... | ... | ...;
     discordSubtext: boolean;
     flavor: "studiocms";
     sanitize: ... | ...;
    }, {
     autoLinkHeadings: ... | ... | ...;
     callouts: ... | ... | ... | ... | ...;
     discordSubtext: ... | ... | ...;
     flavor: "studiocms";
     sanitize: ... | ...;
    }>]>>>;
 }, "strip", ZodTypeAny, {
  html: {
     sanitize: {
        allowAttributes: Record<string, string[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, string[]>;
        dropElements: string[];
       };
    };
  markdown:   | {
     flavor: "astro";
     sanitize: {
        allowAttributes: Record<string, ...[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, ...[]>;
        dropElements: string[];
       };
    }
     | {
     autoLinkHeadings: boolean;
     callouts: false | "github" | "obsidian" | "vitepress";
     discordSubtext: boolean;
     flavor: "studiocms";
     sanitize: {
        allowAttributes: Record<string, ...[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, ...[]>;
        dropElements: string[];
       };
    };
 }, {
  html: {
     sanitize: {
        allowAttributes: Record<string, ...[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, ...[]>;
        dropElements: string[];
       };
    };
  markdown:   | {
     flavor: "astro";
     sanitize: {
        allowAttributes: Record<string, ...[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, ...[]>;
        dropElements: string[];
       };
    }
     | {
     autoLinkHeadings: boolean;
     callouts: false | "github" | "obsidian" | "vitepress";
     discordSubtext: boolean;
     flavor: "studiocms";
     sanitize: {
        allowAttributes: Record<string, ...[]>;
        allowComments: boolean;
        allowComponents: boolean;
        allowCustomElements: boolean;
        allowElements: string[];
        blockElements: string[];
        dropAttributes: Record<string, ...[]>;
        dropElements: string[];
       };
    };
}>>>;

Defined in: studiocms/packages/studiocms/src/schemas/config/pageTypeOptions.ts:51

HTMLSchema

'Read the “', HTMLSchema, '” section'
const HTMLSchema: ZodDefault<ZodOptional<ZodObject<{
  sanitize: ZodOptional<ZodObject<{
     allowAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     allowComments: ZodOptional<ZodBoolean>;
     allowComponents: ZodOptional<ZodBoolean>;
     allowCustomElements: ZodOptional<ZodBoolean>;
     allowElements: ZodOptional<ZodArray<ZodString, "many">>;
     blockElements: ZodOptional<ZodArray<ZodString, "many">>;
     dropAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     dropElements: ZodOptional<ZodArray<ZodString, "many">>;
    }, "strip", ZodTypeAny, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }>>;
 }, "strip", ZodTypeAny, {
  sanitize: {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    };
 }, {
  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/schemas/config/pageTypeOptions.ts:44

MarkdownSchema

'Read the “', MarkdownSchema, '” section'
const MarkdownSchema: ZodDefault<ZodOptional<ZodUnion<[ZodObject<{
  flavor: ZodLiteral<"astro">;
  sanitize: ZodOptional<ZodObject<{
     allowAttributes: ZodOptional<ZodRecord<..., ...>>;
     allowComments: ZodOptional<ZodBoolean>;
     allowComponents: ZodOptional<ZodBoolean>;
     allowCustomElements: ZodOptional<ZodBoolean>;
     allowElements: ZodOptional<ZodArray<..., ...>>;
     blockElements: ZodOptional<ZodArray<..., ...>>;
     dropAttributes: ZodOptional<ZodRecord<..., ...>>;
     dropElements: ZodOptional<ZodArray<..., ...>>;
    }, "strip", ZodTypeAny, {
     allowAttributes: Record<..., ...>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: ...[];
     blockElements: ...[];
     dropAttributes: Record<..., ...>;
     dropElements: ...[];
    }, {
     allowAttributes: Record<..., ...>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: ...[];
     blockElements: ...[];
     dropAttributes: Record<..., ...>;
     dropElements: ...[];
    }>>;
 }, "strip", ZodTypeAny, {
  flavor: "astro";
  sanitize: {
     allowAttributes: Record<string, ...[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, ...[]>;
     dropElements: string[];
    };
 }, {
  flavor: "astro";
  sanitize: {
     allowAttributes: Record<string, ...[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, ...[]>;
     dropElements: string[];
    };
 }>, ZodObject<extendShape<{
  flavor: ZodLiteral<"astro">;
  sanitize: ZodOptional<ZodObject<{
     allowAttributes: ZodOptional<...>;
     allowComments: ZodOptional<...>;
     allowComponents: ZodOptional<...>;
     allowCustomElements: ZodOptional<...>;
     allowElements: ZodOptional<...>;
     blockElements: ZodOptional<...>;
     dropAttributes: ZodOptional<...>;
     dropElements: ZodOptional<...>;
    }, "strip", ZodTypeAny, {
     allowAttributes: ... | ...;
     allowComments: ... | ... | ...;
     allowComponents: ... | ... | ...;
     allowCustomElements: ... | ... | ...;
     allowElements: ... | ...;
     blockElements: ... | ...;
     dropAttributes: ... | ...;
     dropElements: ... | ...;
    }, {
     allowAttributes: ... | ...;
     allowComments: ... | ... | ...;
     allowComponents: ... | ... | ...;
     allowCustomElements: ... | ... | ...;
     allowElements: ... | ...;
     blockElements: ... | ...;
     dropAttributes: ... | ...;
     dropElements: ... | ...;
    }>>;
 }, {
  autoLinkHeadings: ZodDefault<ZodOptional<ZodBoolean>>;
  callouts: ZodDefault<ZodOptional<ZodUnion<[..., ..., ..., ...]>>>;
  discordSubtext: ZodDefault<ZodOptional<ZodBoolean>>;
  flavor: ZodLiteral<"studiocms">;
 }>, "strip", ZodTypeAny, {
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  flavor: "studiocms";
  sanitize: {
     allowAttributes: Record<string, ...[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, ...[]>;
     dropElements: string[];
    };
 }, {
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  flavor: "studiocms";
  sanitize: {
     allowAttributes: Record<string, ...[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, ...[]>;
     dropElements: string[];
    };
}>]>>>;

Defined in: studiocms/packages/studiocms/src/schemas/config/pageTypeOptions.ts:39

StudioCMSMarkdownSchema

'Read the “', StudioCMSMarkdownSchema, '” section'
const StudioCMSMarkdownSchema: ZodObject<extendShape<{
  flavor: ZodLiteral<"astro">;
  sanitize: ZodOptional<ZodObject<{
     allowAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     allowComments: ZodOptional<ZodBoolean>;
     allowComponents: ZodOptional<ZodBoolean>;
     allowCustomElements: ZodOptional<ZodBoolean>;
     allowElements: ZodOptional<ZodArray<ZodString, "many">>;
     blockElements: ZodOptional<ZodArray<ZodString, "many">>;
     dropAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
     dropElements: ZodOptional<ZodArray<ZodString, "many">>;
    }, "strip", ZodTypeAny, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }, {
     allowAttributes: Record<string, string[]>;
     allowComments: boolean;
     allowComponents: boolean;
     allowCustomElements: boolean;
     allowElements: string[];
     blockElements: string[];
     dropAttributes: Record<string, string[]>;
     dropElements: string[];
    }>>;
 }, {
  autoLinkHeadings: ZodDefault<ZodOptional<ZodBoolean>>;
  callouts: ZodDefault<ZodOptional<ZodUnion<[ZodLiteral<"github">, ZodLiteral<"obsidian">, ZodLiteral<"vitepress">, ZodLiteral<false>]>>>;
  discordSubtext: ZodDefault<ZodOptional<ZodBoolean>>;
  flavor: ZodLiteral<"studiocms">;
 }>, "strip", ZodTypeAny, {
  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: 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/schemas/config/pageTypeOptions.ts:29

StudioCMSSanitizeOptionsSchema

'Read the “', StudioCMSSanitizeOptionsSchema, '” section'
const StudioCMSSanitizeOptionsSchema: ZodOptional<ZodObject<{
  allowAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
  allowComments: ZodOptional<ZodBoolean>;
  allowComponents: ZodOptional<ZodBoolean>;
  allowCustomElements: ZodOptional<ZodBoolean>;
  allowElements: ZodOptional<ZodArray<ZodString, "many">>;
  blockElements: ZodOptional<ZodArray<ZodString, "many">>;
  dropAttributes: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
  dropElements: ZodOptional<ZodArray<ZodString, "many">>;
 }, "strip", ZodTypeAny, {
  allowAttributes: Record<string, string[]>;
  allowComments: boolean;
  allowComponents: boolean;
  allowCustomElements: boolean;
  allowElements: string[];
  blockElements: string[];
  dropAttributes: Record<string, string[]>;
  dropElements: string[];
 }, {
  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/schemas/config/pageTypeOptions.ts:3