vite-plugin-decap-cms

Appearance

Reference ​

Plugin config ​

config ​

The configuration for Decap CMS

login ​

Options to customize the login screen (by default on /admin/index.html).

  • Type: LoginPageOptions
  • Required: false

title ​

The page title for the CMS

  • Type: string
  • Default: 'Content Manager'

icon ​

The favicon for the CMS

  • Type: 'string'
  • Required: false

html ​

Use this to replace the login page from the plugin with your own html

  • Type: 'string'
  • Required: false

additionalHtml ​

Use this to add custom html sections to the CMS, such as a footer, navbar, etc.

  • Type: 'string'
  • Required: false

Additional head items for the page. The following items are configured already:

  • title
  • viewport
  • robots
  • charset
  • favicon (if used in the config)
  • Netlify Identity script (if used in the config)
  • custom config path (if used in the config)

Only the title, Netlify Identity script and custom config path cannot be overwritten by this option. To disable these fields, do not use the feature.

  • Type: HeadConfig[]
  • Required: false

netlifyIdentityVersion ​

The version to use for the Netlify Identity widget.

  • Type: string
  • Default: '1'

script ​

  • Type: ScriptOptions
  • Required: false

Event hooks env: browser

All Decap CMS events can be listened to in the script options:

ts
async onPrePublished (ctx) {
    console.log(ctx.entry.get('data').get('title'))
},

onInitialized env: browser ​

ts
onInitialized?(ctx: CmsHookContext): Promise<void> | void

Called when the admin UI is loaded

onGenerated env: node ​

Called when the SSG has been built.

onConfigUpdated env: node ​

Called when the Vite plugin has written configuration

useManualInitialization ​

  • Type: Boolean
  • Default: false

Use manual initialization

formatters ​

  • Type: CmsEditorFormatter[]
  • Default: []

Register custom file formatters

previewStylesheets ​

  • Type: (string | { style: string, options: { raw: true } })[]
  • Default: []

Register custom stylesheets

markdownEditorComponents ​

  • Type: CmsEditorComponentOptions[]
  • Default: []

Register custom components to use in the rich text markdown editor field.

Decap config ​

While most options are the same as the Decap CMS configuration options, there are a few differences:

  • all plugin config options are in camel case, not snake case! The plugin will convert it to snake case for the final config.yml. Note that snake case is still supported, but not typed in TypeScript.
  • some plugin options are dependent on the Vite command run, so the final config can be different between your development and production setup
  • some properties are changed, removed or added. See the list below for all differences.
  • the decap-server proxy is run by default on local backends in serve mode. Use options.proxy to disable the proxy or to change the port / process options.

backend ​

local ​

This option replaces local_backend and allows you to set the value based on the Vite command run

useCurrentBranch ​

A new option to overwrite backend.branch if your backend is git based. Will read the current branch from HEAD.

dir ​

The directory in the public dir where to write the Decap CMS configuration (config.yml) file.

  • Default: 'admin'