index

Variables

studiocms()

const studiocms: (...args: [{
  componentRegistry?: Record<string, string>;
  dbStartPage?: boolean;
  features?: {
     authConfig?: {
        enabled?: boolean;
        providers?: {
           usernameAndPassword?: ... | ... | ...;
           usernameAndPasswordConfig?: ... | ...;
        };
     };
     dashboardConfig?: {
        dashboardEnabled?: boolean;
        dashboardRouteOverride?: string;
        faviconURL?: string;
        inject404Route?: boolean;
        versionCheck?: boolean;
     };
     developerConfig?: {
        demoMode?:   | false
           | {
           password: string;
           username: string;
         };
     };
     injectQuickActionsMenu?: boolean;
     preferredImageService?: string;
     robotsTXT?:   | boolean
        | {
        host?: string | boolean;
        policy?: {
           allow?: ...;
           cleanParam?: ...;
           crawlDelay?: ...;
           disallow?: ...;
           userAgent?: ...;
        }[];
        sitemap?: string | boolean | string[];
      };
     sdk?:   | boolean
        | {
        cacheConfig?:   | boolean
           | {
           lifetime?: ... | ...;
         };
      };
  };
  locale?: {
     dateLocale?: string;
     dateTimeFormat?: DateTimeFormatOptions;
  };
  logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None";
  plugins?: StudioCMSPlugin[];
  verbose?: boolean;
}]) => AstroIntegration & {
};

Defined in: studiocms/packages/studiocms/src/index.ts:94^

StudioCMS Integration

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

Parameters

args

…[{ componentRegistry?: Record<string, string>; dbStartPage?: boolean; features?: { authConfig?: { enabled?: boolean; providers?: { usernameAndPassword?: … | … | …; usernameAndPasswordConfig?: … | …; }; }; dashboardConfig?: { dashboardEnabled?: boolean; dashboardRouteOverride?: string; faviconURL?: string; inject404Route?: boolean; versionCheck?: boolean; }; developerConfig?: { demoMode?: | false | { password: string; username: string; }; }; injectQuickActionsMenu?: boolean; preferredImageService?: string; robotsTXT?: | boolean | { host?: string | boolean; policy?: { allow?: …; cleanParam?: …; crawlDelay?: …; disallow?: …; userAgent?: …; }[]; sitemap?: string | boolean | string[]; }; sdk?: | boolean | { cacheConfig?: | boolean | { lifetime?: … | …; }; }; }; locale?: { dateLocale?: string; dateTimeFormat?: DateTimeFormatOptions; }; logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None"; plugins?: StudioCMSPlugin[]; verbose?: boolean; }]

Returns

AstroIntegration & { }

See

• 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

default

Renames and re-exports studiocms