index

Variables

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

studiocms()

'Read the “', studiocms(), '” section'

const studiocms: (...args: [{
  componentRegistry: Record<string, string>;
  dashboardConfig: {
     AuthConfig: {
        enabled: boolean;
        providers: {
           auth0: ... | ... | ...;
           discord: ... | ... | ...;
           github: ... | ... | ...;
           google: ... | ... | ...;
           usernameAndPassword: ... | ... | ...;
           usernameAndPasswordConfig: ... | ...;
          };
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        demoMode:   | false
           | {
           password: string;
           username: string;
          };
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    };
  dateLocale: string;
  dateTimeFormat: DateTimeFormatOptions;
  dbStartPage: boolean;
  defaultFrontEndConfig:   | boolean
     | {
     favicon: string;
     htmlDefaultHead: {
        attrs: Record<..., ...>;
        content: string;
        tag:   | "title"
           | "base"
           | "link"
           | "style"
           | "meta"
           | "script"
           | "noscript"
           | "template";
       }[];
     htmlDefaultLanguage: string;
     injectQuickActionsMenu: boolean;
    };
  imageService: {
     cdnPlugin: "cloudinary-js";
    };
  includedIntegrations: {
     robotsTXT:   | boolean
        | RobotsConfig;
    };
  overrides: {
     CustomImageOverride: string;
     FormattedDateOverride: string;
    };
  pageTypeOptions: {
     html: {
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       };
     markdown:   | {
        flavor: "astro";
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       }
        | {
        autoLinkHeadings: boolean;
        callouts: false | "github" | "obsidian" | "vitepress";
        discordSubtext: boolean;
        flavor: "studiocms";
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       };
    };
  plugins: StudioCMSPlugin[];
  sdk:   | boolean
     | {
     cacheConfig:   | boolean
        | {
        lifetime: string;
       };
    };
  verbose: boolean;
}]) => AstroIntegration & {};

Defined in: studiocms/packages/studiocms/src/index.ts:181

StudioCMS Integration

A CMS built for Astro by the Astro Community for the Astro Community.

Parameters

'Read the “', Parameters, '” section'

args

'Read the “', args, '” section'

…[{ componentRegistry: Record<string, string>; dashboardConfig: { AuthConfig: { enabled: boolean; providers: { auth0: … | … | …; discord: … | … | …; github: … | … | …; google: … | … | …; usernameAndPassword: … | … | …; usernameAndPasswordConfig: … | …; }; }; dashboardEnabled: boolean; dashboardRouteOverride: string; developerConfig: { demoMode: | false | { password: string; username: string; }; }; faviconURL: string; inject404Route: boolean; versionCheck: boolean; }; dateLocale: string; dateTimeFormat: DateTimeFormatOptions; dbStartPage: boolean; defaultFrontEndConfig: | boolean | { favicon: string; htmlDefaultHead: { attrs: Record<…, …>; content: string; tag: | "title" | "base" | "link" | "style" | "meta" | "script" | "noscript" | "template"; }[]; htmlDefaultLanguage: string; injectQuickActionsMenu: boolean; }; imageService: { cdnPlugin: "cloudinary-js"; }; includedIntegrations: { robotsTXT: | boolean | RobotsConfig; }; overrides: { CustomImageOverride: string; FormattedDateOverride: string; }; pageTypeOptions: { html: { sanitize: { allowAttributes: … | …; allowComments: … | … | …; allowComponents: … | … | …; allowCustomElements: … | … | …; allowElements: … | …; blockElements: … | …; dropAttributes: … | …; dropElements: … | …; }; }; markdown: | { flavor: "astro"; sanitize: { allowAttributes: … | …; allowComments: … | … | …; allowComponents: … | … | …; allowCustomElements: … | … | …; allowElements: … | …; blockElements: … | …; dropAttributes: … | …; dropElements: … | …; }; } | { autoLinkHeadings: boolean; callouts: false | "github" | "obsidian" | "vitepress"; discordSubtext: boolean; flavor: "studiocms"; sanitize: { allowAttributes: … | …; allowComments: … | … | …; allowComponents: … | … | …; allowCustomElements: … | … | …; allowElements: … | …; blockElements: … | …; dropAttributes: … | …; dropElements: … | …; }; }; }; plugins: StudioCMSPlugin[]; sdk: | boolean | { cacheConfig: | boolean | { lifetime: string; }; }; verbose: boolean; }]

Returns

'Read the “', Returns, '” section'

AstroIntegration & {}

See

'Read the “', See, '” section'

• The GitHub Repo: withstudiocms/studiocms^ for more information on how to contribute to StudioCMS.
• The StudioCMS Docs^ for more information on how to use StudioCMS.

References

'Read the “', References, '” section'

default

'Read the “', default, '” section'

Renames and re-exports studiocms