Skip to content
StudioCMS
Landing
Demo
Search
Cancel
GitHub
Discord
YouTube
Select version
Latest
Beta.4
Beta.5
Beta.6
Select theme
Dark
Light
Auto
Start Here
Getting Started with StudioCMS
Updated
Environment Variables
Updated
StudioCMS Config
Why StudioCMS?
Gallery
Plugins
Blog Integration
StudioCMS
Web Vitals
AstroJS
Customizing StudioCMS
@studiocms/renderers
Available Renderers
MarkDoc Renderers
Advanced
Understanding StudioCMS
How does it work!?
Updated
Configuration Reference
StudioCMSOptionsSchema
rendererConfig
markedConfig
markdocConfig
mdxConfig
imageService
defaultFrontEndConfig
dashboardConfig
includedIntegrations
overrides
TypeDoc
Auto Generated
studiocms
index
References
StudioCMSPluginOptions
default
defineStudioCMSPlugin
Variables
defineStudioCMSConfig
Functions
studioCMS
integration
Functions
default
updateCheck
Functions
updateCheck
@studiocms/core
components
References
FormattedDate
GenericHeader
Navigation
Variables
Avatar
consts
Type Aliases
StudioCMSSocials
Variables
CMSSiteConfigId
PLUGIN_INTEGRATION_ICON
studioCMSSocials
db/config
Variables
default
db/tables
Variables
StudioCMSPageContent
StudioCMSPageData
StudioCMSPermissions
StudioCMSSessionTable
StudioCMSSiteConfig
StudioCMSUsers
db/tsTables
Variables
tsPageContent
tsPageData
tsPermissions
tsSessionTable
tsSiteConfig
tsUsers
helpers
References
ContentHelperTempResponse
SiteConfigResponse
StudioCMSRoutes
UserResponse
contentHelper
ensureHtmlExtension
ensureLeadingAndTrailingSlashes
ensureLeadingSlash
ensureTrailingSlash
fileWithBase
getDeleteRoute
getEditRoute
getPageById
getPageList
getPermissionsList
getSiteConfig
getSluggedRoute
getUserById
getUserList
headDefaults
makeAPIDashboardRoute
makeDashboardRoute
makeNonDashboardRoute
pageContentReponse
pageDataReponse
pathWithBase
sideBarLinkMap
stripHtmlExtension
stripLeadingAndTrailingSlashes
stripLeadingSlash
stripTrailingSlash
urlGenFactory
helpers/contentHelper
Type Aliases
ContentHelperTempResponse
pageContentReponse
pageDataReponse
SiteConfigResponse
UserResponse
Functions
contentHelper
getPageById
getPageList
getPermissionsList
getSiteConfig
getUserById
getUserList
helpers/headDefaults
Functions
headDefaults
helpers/pathGenerators
Functions
ensureHtmlExtension
ensureLeadingAndTrailingSlashes
ensureLeadingSlash
ensureTrailingSlash
fileWithBase
pathWithBase
stripHtmlExtension
stripLeadingAndTrailingSlashes
stripLeadingSlash
stripTrailingSlash
helpers/routemap
Variables
sideBarLinkMap
StudioCMSRoutes
Functions
getDeleteRoute
getEditRoute
getSluggedRoute
makeAPIDashboardRoute
makeDashboardRoute
makeNonDashboardRoute
helpers/urlGen
Functions
default
index
Functions
default
integration
Functions
default
lib
References
HeadConfig
HeadConfigSchema
HeadUserConfig
createHead
customRendererPlugin
dashboardPageLinksMap
defineStudioCMSConfig
defineStudioCMSPlugin
externalNavigation
getStudioConfigFileUrl
loadStudioCMSConfigFile
stringify
stringifyMap
studioCMSPluginList
Functions
removeLeadingTrailingSlashes
lib/configManager
Functions
getStudioConfigFileUrl
loadStudioCMSConfigFile
lib/convertDashboardLinksType
Functions
convertDashboardLinksType
lib/defineStudioCMSConfig
Functions
defineStudioCMSConfig
lib/head
References
HeadConfig
HeadConfigSchema
HeadUserConfig
Functions
createHead
lib/jsonUtils
Functions
stringify
stringifyMap
lib/pluginSystem
Variables
customRendererPlugin
dashboardPageLinksMap
externalNavigation
studioCMSPluginList
Functions
defineStudioCMSPlugin
schemas
References
DefaultFrontEndConfigSchema
StudioCMSOptions
StudioCMSOptionsSchema
StudioCMSRendererConfig
StudioCMSRendererConfigSchema
dashboardConfigSchema
imageServiceSchema
overridesSchema
schemas/config
References
DefaultFrontEndConfigSchema
StudioCMSRendererConfig
StudioCMSRendererConfigSchema
dashboardConfigSchema
imageServiceSchema
overridesSchema
Type Aliases
StudioCMSOptions
Variables
StudioCMSOptionsSchema
schemas/config/auth
Type Aliases
AuthProviders
Variables
authConfigSchema
authProviderSchema
schemas/config/componentoverrides
Variables
overridesSchema
schemas/config/dashboard
Variables
dashboardConfigSchema
schemas/config/defaultFrontend
Type Aliases
HeadConfig
HeadUserConfig
Variables
DefaultFrontEndConfigSchema
Functions
HeadConfigSchema
schemas/config/developer
Variables
developerConfigSchema
schemas/config/imageService
Variables
imageServiceSchema
unpicConfigSchema
schemas/config/integrations
Variables
includedIntegrationsSchema
schemas/config/markdoc
Type Aliases
markdocRenderer
Variables
markdocConfigSchema
schemas/config/marked
Variables
markedConfigSchema
markedExtensionsSchema
markedHighlighterConfigSchema
shikiConfigSchema
schemas/config/rendererConfig
References
markdocRenderer
Type Aliases
CustomRenderer
Renderer
StudioCMSRendererConfig
Variables
StudioCMSRendererConfigSchema
schemas/config/unocss
Variables
unocssConfigSchema
unocssDaisyUISchema
unocssPresetsSchema
strings
Variables
authConfigStrings
AuthProviderLogStrings
CheckENVStrings
cloudflareImageHandlerStrings
CoreStrings
DashboardStrings
DbErrors
genericAdapterStrings
imageHandlerStrings
MakeFrontendStrings
netlifyImageHandlerStrings
nodeImageHandlerStrings
robotsTXTPreset
studioErrors
vercelImageHandlerStrings
warnings
webVitalStrings
types
References
AuthConfigMap
DashboardPageLink
PageDataAndContent
PageDataAndContentSchema
ScryptOptsRemap
SideBarLink
StudioCMSPluginOptions
usernameAndPasswordConfig
types/auth-types
Type Aliases
AuthConfigMap
ScryptOptsRemap
usernameAndPasswordConfig
types/dbtypehelpers
Type Aliases
PageDataAndContent
Variables
PageDataAndContentSchema
types/locals
Type Aliases
Locals
Variables
LocalsSchema
types/pluginOptions
Type Aliases
DashboardPageLink
StudioCMSPluginOptions
types/sideBarLinkType
Type Aliases
SideBarLink
@studiocms/dashboard
components
References
Footer
Header
Layout
SideBar
SideBarFooter
SideBarMenu
ThemeManager
ThemeToggleButton
Variables
BaseHead
index
Functions
default
integration
Functions
default
utils/astroDb
Functions
astroDb
utils/isDashboardRoute
Functions
isDashboardRoute
utils/makePageTitle
Functions
makePageTitle
utils/pageListPackageLabel
Functions
fixPackageLabel
utils/simpleResponse
Functions
simpleResponse
utils/webVital
Type Aliases
WebVitalsResponseItem
Functions
getWebVitals
@studiocms/auth
astroenv/env
Variables
astroENV
auth
Variables
lucia
auth/lucia-astrodb-adapter
Classes
AstroDBAdapter
Type Aliases
SessionTable
UserTable
helpers/authHelper
Functions
default
index
Functions
default
integration
Functions
default
middleware
Functions
onRequest
middleware/router
Functions
defineMiddlewareRouter
utils/authEnvCheck
Functions
authEnvCheck
utils/checkENV
Functions
checkEnvKeys
@studiocms/frontend
components
References
Footer
Layout
Variables
BaseHead
index
Functions
default
integration
Functions
default
@studiocms/imagehandler
adapters/cloudflare
Functions
default
adapters/netlify
Functions
default
adapters/node
Functions
default
adapters/vercel
Functions
default
components
Variables
CustomImage
index
Functions
default
integration
Functions
default
supportedAdapters
Variables
supportedAdapters
@studiocms/renderers
components
References
StudioCMSRenderer
exports
References
markDocRenderReact
markdocReactComponents
exports/markdocRenderers/markdocReact
References
default
Type Aliases
markdocReactComponents
Functions
markDocRenderReact
index
References
StudioCMSRendererConfig
Variables
StudioCMSRendererConfigSchema
Functions
default
integration
Functions
default
lib/astro-remark
References
default
Functions
renderAstroMD
lib/contentRenderer
References
default
Type Aliases
ContentRenderer
Functions
contentRenderer
lib/markdoc
References
default
Functions
renderMarkDoc
lib/markdoc/markdocHTML
References
default
Functions
renderHTML
lib/markdoc/markdocReactStatic
References
default
Functions
renderReactStatic
lib/marked
References
default
Variables
emojiMap
Functions
renderMarked
lib/mdx
References
default
Functions
renderAstroMDX
@studiocms/robotstxt
consts
Type Aliases
SearchEngineOptimization
SearchEngines
SocialNetwork
UsertAgentType
core
Functions
generateContent
printInfo
index
Interfaces
PolicyOptions
RobotsConfig
Functions
default
utils/measureExecutionTime
Functions
default
GitHub
Discord
YouTube
Select version
Latest
Beta.4
Beta.5
Beta.6
Select theme
Dark
Light
Auto
defineStudioCMSConfig
defineStudioCMSConfig
:
any
