index

Functions

'Read the “', Functions, '” section'

studiocms()

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

function studiocms(...args: [{
  componentRegistry: Record<string, string>;
  dashboardConfig: {
     AuthConfig: {
        enabled: boolean;
        providers: {
           auth0: boolean;
           discord: boolean;
           github: boolean;
           google: boolean;
           usernameAndPassword: boolean;
           usernameAndPasswordConfig: {
              allowUserRegistration: ...;
             };
          };
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        testingAndDemoMode: boolean;
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    };
  dateLocale: string;
  dateTimeFormat: DateTimeFormatOptions;
  dbStartPage: boolean;
  defaultFrontEndConfig:   | boolean
     | {
     favicon: string;
     htmlDefaultHead: {
        attrs: Record<string, ... | ... | ... | ...>;
        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;
    };
  plugins: StudioCMSPlugin[];
  rendererConfig: {
     markdocConfig: {
        argParse: {
           file: string;
           location: boolean;
           slots: boolean;
          };
        renderType:   | "html"
           | "react-static"
           | MarkdocRenderer;
        transformConfig: {
           functions: Record<..., ...>;
           nodes: Record<..., ...>;
           partials: Record<..., ...>;
           tags: Record<..., ...>;
           validation: {
              environment: ...;
              parents: ...;
              validateFunctions: ...;
             };
           variables: Record<..., ...>;
          };
       };
     mdxConfig: {
        recmaPlugins: PluggableList;
        rehypePlugins: PluggableList;
        remarkPlugins: PluggableList;
        remarkRehypeOptions: {
           allowDangerousHtml: null | boolean;
           clobberPrefix: null | string;
           file: any;
           footnoteBackContent: null | string | (...args: ...) => ...;
           footnoteBackLabel: null | string | (...args: ...) => ...;
           footnoteLabel: null | string;
           footnoteLabelProperties: null | Record<..., ...>;
           footnoteLabelTagName: null | string;
           handlers: any;
           passThrough: null | ...[];
           unknownHandler: any;
          };
       };
     renderer:   | "studiocms"
        | "astro"
        | "markdoc"
        | "mdx"
        | CustomRenderer;
     studiocms:   | false
        | {
        autoLinkHeadings: boolean;
        callouts:   | false
           | {
           theme: "github" | "obsidian" | "vitepress";
          };
        discordSubtext: boolean;
        sanitize: {
           allowAttributes: Record<..., ...>;
           allowComments: boolean;
           allowComponents: boolean;
           allowCustomElements: boolean;
           allowElements: ...[];
           blockElements: ...[];
           dropAttributes: Record<..., ...>;
           dropElements: ...[];
          };
       };
    };
  sdk:   | boolean
     | {
     cacheConfig:   | boolean
        | {
        lifetime: string;
       };
    };
  verbose: boolean;
}]): AstroIntegration & {}

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

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: boolean; discord: boolean; github: boolean; google: boolean; usernameAndPassword: boolean; usernameAndPasswordConfig: { allowUserRegistration: …; }; }; }; dashboardEnabled: boolean; dashboardRouteOverride: string; developerConfig: { testingAndDemoMode: boolean; }; faviconURL: string; inject404Route: boolean; versionCheck: boolean; }; dateLocale: string; dateTimeFormat: DateTimeFormatOptions; dbStartPage: boolean; defaultFrontEndConfig: | boolean | { favicon: string; htmlDefaultHead: { attrs: Record<string, … | … | … | …>; 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; }; plugins: StudioCMSPlugin[]; rendererConfig: { markdocConfig: { argParse: { file: string; location: boolean; slots: boolean; }; renderType: | "html" | "react-static" | MarkdocRenderer; transformConfig: { functions: Record<…, …>; nodes: Record<…, …>; partials: Record<…, …>; tags: Record<…, …>; validation: { environment: …; parents: …; validateFunctions: …; }; variables: Record<…, …>; }; }; mdxConfig: { recmaPlugins: PluggableList; rehypePlugins: PluggableList; remarkPlugins: PluggableList; remarkRehypeOptions: { allowDangerousHtml: null | boolean; clobberPrefix: null | string; file: any; footnoteBackContent: null | string | (…args: …) => …; footnoteBackLabel: null | string | (…args: …) => …; footnoteLabel: null | string; footnoteLabelProperties: null | Record<…, …>; footnoteLabelTagName: null | string; handlers: any; passThrough: null | …[]; unknownHandler: any; }; }; renderer: | "studiocms" | "astro" | "markdoc" | "mdx" | CustomRenderer; studiocms: | false | { autoLinkHeadings: boolean; callouts: | false | { theme: "github" | "obsidian" | "vitepress"; }; discordSubtext: boolean; sanitize: { allowAttributes: Record<…, …>; allowComments: boolean; allowComponents: boolean; allowCustomElements: boolean; allowElements: …[]; blockElements: …[]; dropAttributes: Record<…, …>; dropElements: …[]; }; }; }; 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