config
Ce contenu n’est pas encore disponible dans votre langue.
Functions
'Read the “', Functions, '” section'defineStudioCMSConfig()
'Read the “', defineStudioCMSConfig(), '” section'function defineStudioCMSConfig(config: | undefined | { 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: { 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<string, undefined | string | boolean>; 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: 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[]; }; }; }; plugins: StudioCMSPlugin[]; sdk: | boolean | { cacheConfig: | boolean | { lifetime: string; }; }; verbose: boolean; }): | undefined | { 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: { 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<string, undefined | string | boolean>; 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: 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[]; }; }; }; plugins: StudioCMSPlugin[]; sdk: | boolean | { cacheConfig: | boolean | { lifetime: string; }; }; verbose: boolean;}Defined in: studiocms/packages/studiocms/src/utils/defineStudioCMSConfig.ts:31
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project’s astro.config.mjs file.
StudioCMS will attempt to import this file and use the default export as the StudioCMS config object automatically if it exists.
Using this function is optional, but it can be useful for IDEs to provide better intellisense and type checking.
Parameters
'Read the “', Parameters, '” section'undefined |
{
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: {
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<string, undefined | string | boolean>;
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: 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[];
};
};
};
plugins: StudioCMSPlugin[];
sdk: | boolean
| {
cacheConfig: | boolean
| {
lifetime: string;
};
};
verbose: boolean;
}
componentRegistry?
'Read the “', componentRegistry?, '” section'Record<string, string> = ...
Component Registry
dashboardConfig?
'Read the “', dashboardConfig?, '” section'{
AuthConfig: {
enabled: boolean;
providers: {
auth0: boolean;
discord: boolean;
github: boolean;
google: boolean;
usernameAndPassword: boolean;
usernameAndPasswordConfig: {
allowUserRegistration: … | … | …;
};
};
};
dashboardEnabled: boolean;
dashboardRouteOverride: string;
developerConfig: {
demoMode: | false
| {
password: string;
username: string;
};
};
faviconURL: string;
inject404Route: boolean;
versionCheck: boolean;
} = dashboardConfigSchema
Allows customization of the Dashboard Configuration
dashboardConfig.AuthConfig?
'Read the “', dashboardConfig.AuthConfig?, '” section'{
enabled: boolean;
providers: {
auth0: boolean;
discord: boolean;
github: boolean;
google: boolean;
usernameAndPassword: boolean;
usernameAndPasswordConfig: {
allowUserRegistration: … | … | …;
};
};
} = authConfigSchema
Auth Configuration - Allows customization of the Authentication Configuration
dashboardConfig.AuthConfig.enabled?
'Read the “', dashboardConfig.AuthConfig.enabled?, '” section'boolean = ...
Auth Enabled - Allows enabling or disabling of the Authentication Configuration
Default
truedashboardConfig.AuthConfig.providers?
'Read the “', dashboardConfig.AuthConfig.providers?, '” section'{
auth0: boolean;
discord: boolean;
github: boolean;
google: boolean;
usernameAndPassword: boolean;
usernameAndPasswordConfig: {
allowUserRegistration: … | … | …;
};
} = authProviderSchema
Auth Providers - Allows enabling or disabling of the Authentication Providers
dashboardConfig.AuthConfig.providers.auth0?
'Read the “', dashboardConfig.AuthConfig.providers.auth0?, '” section'boolean = ...
Auth0 Auth Provider - Powered by Arctic
Requires an Auth0 Application to be created and configured using ENV Variables
Default
falsedashboardConfig.AuthConfig.providers.discord?
'Read the “', dashboardConfig.AuthConfig.providers.discord?, '” section'boolean = ...
Discord Auth Provider - Powered by Arctic
Requires a Discord OAuth App to be created and configured using ENV Variables
Default
falsedashboardConfig.AuthConfig.providers.github?
'Read the “', dashboardConfig.AuthConfig.providers.github?, '” section'boolean = ...
GitHub Auth Provider - Powered by Arctic
Requires a GitHub OAuth App to be created and configured using ENV Variables
Default
falsedashboardConfig.AuthConfig.providers.google?
'Read the “', dashboardConfig.AuthConfig.providers.google?, '” section'boolean = ...
Google Auth Provider - Powered by Arctic
Requires a Google OAuth App to be created and configured using ENV Variables
Default
falsedashboardConfig.AuthConfig.providers.usernameAndPassword?
'Read the “', dashboardConfig.AuthConfig.providers.usernameAndPassword?, '” section'boolean = ...
Username and Password Auth Provider
dashboardConfig.AuthConfig.providers.usernameAndPasswordConfig?
'Read the “', dashboardConfig.AuthConfig.providers.usernameAndPasswordConfig?, '” section'{
allowUserRegistration: … | … | …;
} = localUsernameAndPasswordConfig
dashboardConfig.AuthConfig.providers.usernameAndPasswordConfig.allowUserRegistration?
'Read the “', dashboardConfig.AuthConfig.providers.usernameAndPasswordConfig.allowUserRegistration?, '” section'… | … | … = ...
Allow User Registration - Allows users to register an account
Default
falsedashboardConfig.dashboardEnabled?
'Read the “', dashboardConfig.dashboardEnabled?, '” section'boolean = ...
OPTIONAL - This allows the user to enable or disable the Astro StudioCMS dashboard but still provide all the helper’s and utilities to those who are customizing their setup, doing so will disable the dashboard and you will need to manage your content via your database
Default
truedashboardConfig.dashboardRouteOverride?
'Read the “', dashboardConfig.dashboardRouteOverride?, '” section'string = ...
OPTIONAL - This allows the user to override the default dashboard route to a custom route
Note: Use with caution, this is an advanced feature
Usage
- The default route is
dashboardwithout any/or\characters. If you want to override the route to/adminyou would set this value toadmin
Default
"dashboard"dashboardConfig.developerConfig?
'Read the “', dashboardConfig.developerConfig?, '” section'{
demoMode: | false
| {
password: string;
username: string;
};
} = developerConfigSchema
Developer Options/Configuration
dashboardConfig.developerConfig.demoMode?
'Read the “', dashboardConfig.developerConfig.demoMode?, '” section'| false
| {
password: string;
username: string;
} = ...
Enable demo mode for the site
If set to an object, the site will be in demo mode, and the user will be able to login with the provided username and password.
Default
falseExample
{demoMode: {username: "demo_user",password: "some-demo-password"}}dashboardConfig.faviconURL?
'Read the “', dashboardConfig.faviconURL?, '” section'string = ...
OPTIONAL - This allows the user to override the default Favicon URL to a custom URL
dashboardConfig.inject404Route?
'Read the “', dashboardConfig.inject404Route?, '” section'boolean = ...
OPTIONAL - This allows the user to enable or disable the default 404 route for the dashboard
Default
truedashboardConfig.versionCheck?
'Read the “', dashboardConfig.versionCheck?, '” section'boolean = ...
OPTIONAL - This allows the user to enable or disable the version check for the dashboard
This will check for the latest version of StudioCMS and notify the user if there is a new version available.
Default
truedateLocale?
'Read the “', dateLocale?, '” section'string = ...
Date Locale used for formatting dates
dateTimeFormat?
'Read the “', dateTimeFormat?, '” section'DateTimeFormatOptions = ...
DateTime Format Options
dbStartPage?
'Read the “', dbStartPage?, '” section'boolean = ...
Project Initialization Page - Used during First Time Setup to initialize the database
Default
truedefaultFrontEndConfig?
'Read the “', defaultFrontEndConfig?, '” section'| boolean
| {
favicon: string;
htmlDefaultHead: {
attrs: Record<string, undefined | string | boolean>;
content: string;
tag: | "title"
| "base"
| "link"
| "style"
| "meta"
| "script"
| "noscript"
| "template";
}[];
htmlDefaultLanguage: string;
injectQuickActionsMenu: boolean;
} = DefaultFrontEndConfigSchema
Default Frontend Configuration
Allows customization of the default frontend configuration
Default
trueimageService?
'Read the “', imageService?, '” section'{
cdnPlugin: "cloudinary-js";
} = imageServiceSchema
Allows customization of the Image Service Options
imageService.cdnPlugin?
'Read the “', imageService.cdnPlugin?, '” section'"cloudinary-js" = ...
If the user wants to use a custom Supported CDN Plugin, they can specify it here.
Currently Supported CDN Plugins: cloudinary-js
includedIntegrations?
'Read the “', includedIntegrations?, '” section'{
robotsTXT: | boolean
| RobotsConfig;
} = includedIntegrationsSchema
Allows enabling and disabling of the included integrations
includedIntegrations.robotsTXT?
'Read the “', includedIntegrations.robotsTXT?, '” section'| boolean
| RobotsConfig = ...
Allows the user to enable/disable the use of the StudioCMS Custom astro-robots-txt Integration
Default
robotsTXT: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }overrides?
'Read the “', overrides?, '” section'{
CustomImageOverride: string;
FormattedDateOverride: string;
} = overridesSchema
Component Overrides - Allows for customizing the components used in StudioCMS
overrides.CustomImageOverride?
'Read the “', overrides.CustomImageOverride?, '” section'string = ...
Allows the user to override the default image component used in StudioCMS for rendering images.
overrides.FormattedDateOverride?
'Read the “', overrides.FormattedDateOverride?, '” section'string = ...
Allows the user to override the default formatted date component used in StudioCMS for rendering dates.
pageTypeOptions?
'Read the “', pageTypeOptions?, '” section'{
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[];
};
};
} = BuiltInPageTypeOptionsSchema
Page Type Options
pageTypeOptions.html?
'Read the “', pageTypeOptions.html?, '” section'{
sanitize: {
allowAttributes: Record<string, …[]>;
allowComments: boolean;
allowComponents: boolean;
allowCustomElements: boolean;
allowElements: string[];
blockElements: string[];
dropAttributes: Record<string, …[]>;
dropElements: string[];
};
} = HTMLSchema
pageTypeOptions.html.sanitize?
'Read the “', pageTypeOptions.html.sanitize?, '” section'{
allowAttributes: Record<string, …[]>;
allowComments: boolean;
allowComponents: boolean;
allowCustomElements: boolean;
allowElements: string[];
blockElements: string[];
dropAttributes: Record<string, …[]>;
dropElements: string[];
} = StudioCMSSanitizeOptionsSchema
pageTypeOptions.html.sanitize.allowAttributes?
'Read the “', pageTypeOptions.html.sanitize.allowAttributes?, '” section'Record<string, …[]> = ...
An object where each key is the attribute name and the value is an array of allowed tag names. Matching attributes will not be removed. All attributes that are not in the array will be dropped.
pageTypeOptions.html.sanitize.allowComments?
'Read the “', pageTypeOptions.html.sanitize.allowComments?, '” section'boolean = ...
A boolean value to remove HTML comments. Set to true in order to keep comments. Default is false.
pageTypeOptions.html.sanitize.allowComponents?
'Read the “', pageTypeOptions.html.sanitize.allowComponents?, '” section'boolean = ...
A boolean value to remove components and their children. If set to true, components will be subject to built-in and custom configuration checks (and will be retained or dropped based on those checks). Default is false.
pageTypeOptions.html.sanitize.allowCustomElements?
'Read the “', pageTypeOptions.html.sanitize.allowCustomElements?, '” section'boolean = ...
A boolean value to remove custom elements and their children. If set to true, custom elements will be subject to built-in and custom configuration checks (and will be retained or dropped based on those checks). Default is false
pageTypeOptions.html.sanitize.allowElements?
'Read the “', pageTypeOptions.html.sanitize.allowElements?, '” section'string[] = ...
An Array of strings indicating elements that the sanitizer should not remove. All elements not in the array will be dropped.
pageTypeOptions.html.sanitize.blockElements?
'Read the “', pageTypeOptions.html.sanitize.blockElements?, '” section'string[] = ...
An Array of strings indicating elements that the sanitizer should remove. Children will be kept.
pageTypeOptions.html.sanitize.dropAttributes?
'Read the “', pageTypeOptions.html.sanitize.dropAttributes?, '” section'Record<string, …[]> = ...
An object where each key is the attribute name and the value is an array of dropped tag names. Matching attributes will be removed.
pageTypeOptions.html.sanitize.dropElements?
'Read the “', pageTypeOptions.html.sanitize.dropElements?, '” section'string[] = ...
An Array of strings indicating elements (including nested elements) that the sanitizer should remove.
pageTypeOptions.markdown?
'Read the “', pageTypeOptions.markdown?, '” section'| {
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[];
};
} = MarkdownSchema
Options for the studiocms/markdown pageType
StudioCMSPlugin[] = ...
Add Plugins to the StudioCMS
| boolean
| {
cacheConfig: | boolean
| {
lifetime: string;
};
} = SDKSchema
SDKSchema is a Zod schema that validates the SDK configuration. It can either be a boolean or an object containing cache configuration.
If it is a boolean, it defaults to true and transforms into an object
with default cache configuration.
If it is an object, it must contain the cacheConfig property which is
validated by the SDKCacheSchema.
boolean = ...
Whether to show verbose output
Default
false| undefined
| {
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: {
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<string, undefined | string | boolean>;
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: 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[];
};
};
};
plugins: StudioCMSPlugin[];
sdk: | boolean
| {
cacheConfig: | boolean
| {
lifetime: string;
};
};
verbose: boolean;
}
import { defineStudioCMSConfig } from 'studiocms';
export default defineStudioCMSConfig({ dbStartPage: true, contentRenderer: 'marked', verbose: true, dateLocale: 'en-us', // ...Other Options})References
'Read the “', References, '” section'StudioCMSOptions
'Read the “', StudioCMSOptions, '” section'Re-exports StudioCMSOptions