StudioCMSOptions

此内容尚不支持你的语言。

StudioCMS Integration config options schema reference

// Default Values shown
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.dbStartPage?: boolean
Project Initialization Page - Used during First Time Setup to initialize the database
@default ― true
dbStartPage: true,
  
StudioCMSOptions.db?: DBConfigSchema
Database Configuration
db: {},
  
StudioCMSOptions.verbose?: boolean
Whether to show verbose output
@default ― false
verbose: false,
  
StudioCMSOptions.logLevel?: "Info" | "All" | "Fatal" | "Error" | "Warning" | "Debug" | "Trace" | "None"
Set the LogLevel for Effect based code
logLevel: 'Info',
  
StudioCMSOptions.plugins?: StudioCMSPlugin[]
Add Plugins to the StudioCMS
plugins: [],
  
StudioCMSOptions.componentRegistry?: Record<string, string>
Component Registry
componentRegistry: {},
  
StudioCMSOptions.locale?: LocaleConfig
Locale specific settings
locale: {},
  
StudioCMSOptions.features?: FeaturesConfig
Allows adjusting the StudioCMS Dashboard features
features: {}
});

`dbStartPage`

Project initialization page - Used during first time setup to create your database configuration.

Type: boolean
Default: true

Usage

export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.dbStartPage?: boolean
Project Initialization Page - Used during First Time Setup to initialize the database
@default ― true
dbStartPage: true, // DEFAULT - This injects a start page to setup your DB data.
})

`db`

db is an object that is used to configure the database dialect.

Type: DBConfigSchema
Default: {}

Usage

export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.db?: DBConfigSchema
Database Configuration
db: {
    
DBConfigSchema.dialect?: "libsql" | "postgres" | "mysql"
Database Dialect to use
@default ― 'libsql'
dialect: 'libsql', // 'libsql' | 'postgresql' | 'mysql'
  },
})

`storageManager`

storageManager is used to configure the storage manager plugin for StudioCMS.

Type: StudioCMSStorageManager
Default: undefined

Usage

import 
function s3Storage(): StudioCMSStorageManager
Creates and configures a StudioCMS S3 Storage Manager plugin.
This function initializes the S3 storage integration for StudioCMS by defining
a storage manager plugin with the necessary configuration and hooks.
@returns ― A configured storage manager instance that integrates
S3 storage capabilities with StudioCMS.
@example 
import { studiocmsS3Storage } from '@studiocms/s3-storage';

const s3Storage = studiocmsS3Storage();
s3Storage from '@studiocms/s3-storage';
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.storageManager?: StudioCMSStorageManager
Storage Manager Configuration
storageManager: 
function s3Storage(): StudioCMSStorageManager
Creates and configures a StudioCMS S3 Storage Manager plugin.
This function initializes the S3 storage integration for StudioCMS by defining
a storage manager plugin with the necessary configuration and hooks.
@returns ― A configured storage manager instance that integrates
S3 storage capabilities with StudioCMS.
@example 
import { studiocmsS3Storage } from '@studiocms/s3-storage';

const s3Storage = studiocmsS3Storage();
s3Storage(),
})

`verbose`

verbose is a boolean that is used to enable or disable verbose logging.

Type: boolean
Default: false

Usage

export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.verbose?: boolean
Whether to show verbose output
@default ― false
verbose: false, // DEFAULT - This sets the verbose logging to false.
})

`logLevel`

logLevel is a union for setting the LogLevel for Effect based code.

Type: All | Fatal | Error | Warning | Info | Debug | Trace | None
Default: Info

Usage

export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.logLevel?: "Info" | "All" | "Fatal" | "Error" | "Warning" | "Debug" | "Trace" | "None"
Set the LogLevel for Effect based code
logLevel: 'Info', // DEFAULT
})

`plugins`

plugins is an array that is used to determine which plugins should be loaded.

Type: StudioCMSPlugin[]
Default: []

Usage

import 
function blog(options?: StudioCMSBlogOptions): StudioCMSPlugin
Creates and configures the StudioCMS Blog plugin.
@param ― options - Optional configuration options for the blog plugin.
@returns ― The configured StudioCMS plugin.
@example 
const blogPlugin = studioCMSBlogPlugin({
  blog: {
    title: 'My Blog',
    enableRSS: true,
    route: '/my-blog'
  },
  sitemap: true,
  injectRoutes: true
});
@param ― options.blog - Blog-specific options.
@param ― options.blog.title - The title of the blog. Defaults to 'Blog'.
@param ― options.blog.enableRSS - Whether to enable RSS feed. Defaults to true.
@param ― options.blog.route - The route for the blog. Defaults to '/blog'.
@param ― options.sitemap - Whether to trigger sitemap generation. Defaults to true.
@param ― options.injectRoutes - Whether to inject routes for the blog. Defaults to true.
blog from '@studiocms/blog';
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.plugins?: StudioCMSPlugin[]
Add Plugins to the StudioCMS
plugins: [
    
function blog(options?: StudioCMSBlogOptions): StudioCMSPlugin
Creates and configures the StudioCMS Blog plugin.
@param ― options - Optional configuration options for the blog plugin.
@returns ― The configured StudioCMS plugin.
@example 
const blogPlugin = studioCMSBlogPlugin({
  blog: {
    title: 'My Blog',
    enableRSS: true,
    route: '/my-blog'
  },
  sitemap: true,
  injectRoutes: true
});
@param ― options.blog - Blog-specific options.
@param ― options.blog.title - The title of the blog. Defaults to 'Blog'.
@param ― options.blog.enableRSS - Whether to enable RSS feed. Defaults to true.
@param ― options.blog.route - The route for the blog. Defaults to '/blog'.
@param ― options.sitemap - Whether to trigger sitemap generation. Defaults to true.
@param ― options.injectRoutes - Whether to inject routes for the blog. Defaults to true.
blog(),
  ],
})

`componentRegistry`

componentRegistry is an object that is used to register components.

Type: Record<string, string>
Default: {}

Usage

export default 
function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
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.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';

export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
StudioCMSOptions.componentRegistry?: Record<string, string>
Component Registry
componentRegistry: {
    'my-component': './src/components/MyComponent.astro',
  },
})

`locale`

locale allows setting Locale specific settings

See locale for full options

`features`

features is an object that allows adjusting the StudioCMS Dashboard features

See features for full options