@cajuinasi/sveltia-cms
v0.125.1
Published
Sveltia CMS is a modern, lightweight, Git-based headless content management system.
Downloads
667
Readme
Sveltia CMS: Netlify/Decap CMS successor
Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, powerful, direct replacement for Netlify CMS (now Decap CMS). We have picked up where they left off and have already solved over 275 issues reported in the predecessor’s repository, ranging from critical bugs to top feature requests.
Built from the ground up, Sveltia CMS offers excellent UX, DX, performance, security and internationalization (i18n) support. Although some features are still missing, our numerous enhancements across the board ensure smooth daily workflows for content editors and developers alike.
This free, open source successor to Netlify/Decap CMS is currently in public beta, with version 1.0 expected in early 2026.






Table of contents
- Motivation
- Project Status
- Differentiators
- Better UX
- Better performance
- Better productivity
- Better security
- Better accessibility
- Better installation
- Better configuration
- Better backend support
- Better i18n support
- Better collections
- Better content editing
- Better content preview
- Better data output
- Better widgets
- Better asset management
- Better customization
- Better localization
- Better documentation
- Compatibility
- Getting Started
- Tips & Tricks
- Moving your site from Netlify to another hosting service
- Enabling autocomplete and validation for the configuration file
- Providing a JSON configuration file
- Providing a TOML configuration file
- Providing multiple configuration files
- Working around an authentication error
- Working with a local Git repository
- Enabling local development in Brave
- Using a custom icon for a collection
- Adding dividers to the collection list
- Using a custom media folder for a collection
- Specifying default sort field and direction
- Including Hugo’s special index file in a folder collection
- Using singletons
- Using keyboard shortcuts
- Controlling entry file paths
- Translating entry fields with one click
- Localizing entry slugs
- Disabling non-default locale content
- Using a random ID for an entry slug
- Configuring multiple media libraries
- Optimizing images for upload
- Disabling stock assets
- Using entry tags for categorization
- Editing site deployment configuration files
- Editing data files with a top-level list
- Changing the input type of a DateTime field
- Rendering soft line breaks as hard line breaks in Markdown
- Controlling data output
- Understanding exceptions in data output
- Disabling automatic deployments
- Setting up Content Security Policy
- Showing the CMS version
- Support & Feedback
- Contributions
- Roadmap
- Related Links
- Privacy
- Disclaimer
- Acknowledgements
Motivation
Sveltia CMS was born in November 2022, when the progress of Netlify CMS was stalled for more than six months. @kyoshino’s clients wanted to replace their Netlify CMS instances without much effort, mainly to get better internationalization (i18n) support.
To achieve radical improvements in UX, performance, i18n and other areas, it was ultimately decided to build an alternative from the ground up, while ensuring an easy migration path from the other. After proving the idea with a rapid Svelte prototype, development was accelerated to address their primary use cases. The new product has since been named Sveltia CMS and released as open source software to encourage wider adoption.
We loved the simple, unique setup of Netlify CMS that turned a Git repository into a database with a single page app served from a CDN plus a plain YAML config file. In support of the Jamstack concept, we wanted to revive it, modernize it, and take it to the next level.
Our advantage
Due to its unfortunate abandonment in early 2022, Netlify CMS spawned 3 successors:
- Static CMS: a community fork
- Initial commit made in September 2022
- ❌ Discontinued in September 2024 after making meaningful improvements
- Sveltia CMS: not a fork but a complete rewrite
- Started in November 2022, first appeared on GitHub in March 2023
- ✅ Actively developed with frequent releases and numerous improvements
- ✅ Relevant issues are being resolved regardless of their age or status
- ✅ Most of new bug reports are addressed promptly, usually within a day
- ✅ An extensive roadmap is available to keep users informed
- ✅ No known unpatched security vulnerabilities, with dependencies kept up-to-date
- Decap CMS: a rebranded version
- Announced in February 2023 as an official continuation with a Netlify agency partner taking ownership
- ⚠️ Mostly low activity with only occasional releases and a few minor improvements
- ⚠️ Seemingly random issues were closed as stale following the takeover
- ⚠️ Bug reports continue to pile up, often without any response
- ⚠️ No public roadmap is available, leaving users in the dark
- ❌ A moderate severity XSS vulnerability, high severity dependency vulnerabilities and fatal crashes remain unaddressed
Sveltia CMS is the only project that doesn’t inherit the complexity, technical debt, and numerous bugs of Netlify CMS, which was launched in 2015. Our product is better by design:
- We rebuilt the app from scratch using a modern framework
- We don’t reuse any part of the predecessor’s codebase
- We incorporate i18n support into the core instead of adding it as an afterthought
- We closely monitor and analyze the predecessor’s issue tracker
- We rearchitect the entire user experience (UX) and developer experience (DX)
This "total reboot” has enabled us to implement hundreds of improvements without getting stuck in a legacy system. Furthermore:
- We dedicate significant time and effort to modernizing the platform
- We continue to address issues reported in the predecessor’s repository
- We materialize the enhancements that Netlify CMS users have long desired
For that reason, Sveltia CMS is the true successor to Netlify CMS — not just a spiritual successor or a mere alternative — and the best choice for users looking to migrate from the predecessor, other successors, or even other CMS solutions.
Our goals
- Making Sveltia CMS a viable, definitive successor to Netlify CMS
- Empowering SMBs and individuals who need a free, yet powerful, high-quality CMS solution
- Emerging as the leading open source offering in the Git-based CMS market
- Extending its capabilities as digital asset management (DAM) software
- Showcasing the power of Svelte and UX engineering
Project Status
Sveltia CMS is currently in beta, with version 1.0 (GA) scheduled for release in early 2026. Check our release notes and follow us on Bluesky for updates. See also our roadmap.
While we fix reported bugs as quickly as possible, usually within 24 hours, our overall progress may be slower than you think. The thing is, it’s not just a personal project of @kyoshino, but also a complicated system involving various kinds of activities that require considerable effort:
- Ensuring near-complete compatibility with Netlify/Decap CMS
- The vast majority of existing configurations work out of the box
- It works as a drop-in replacement for most use cases
- Some missing features will be implemented before or shortly after GA
- Tackling as many Netlify/Decap CMS issues as possible
- So far, 275+ issues, or 595+ if including duplicates, have been effectively solved in Sveltia CMS (Yes, you read it right)
- Target:
- 300 issues, or 600 if including duplicates, by GA — Almost there! 🚀
- 450 issues, or 900 if including duplicates, in the future 💪
- or every single issue that’s relevant, fixable, and worth dealing with 🔥
- Issues include everything:
- Outstanding issues from feature requests to bug reports
- Issues closed as stale or without an optimal solution
- Discussions
- Stalled pull requests
- Many of the bugs, including the annoying crashes, have already been solved
- The remaining bugs are mostly related to unimplemented features
- Many of their top-voted features are on our table or already implemented in Sveltia CMS
- Solving our own issues
- Preparing top-notch documentation
- Implementing our own enhancement ideas for every part of the product

Differentiators
Netlify/Decap CMS users will definitely be pleased and surprised by the numerous improvements we have made, from the small to the large. Here’s what makes Sveltia CMS different. Look how serious we are!
Note: This lengthy section compares Sveltia CMS with both Netlify CMS and Decap CMS. Some of the listed issues may have been fixed in the current version of Decap CMS.
Better UX
- Created and actively maintained by an experienced UX engineer who loves code, design, marketing, localization, documentation and everything in between. You can expect constant improvements to the user experience (UX) and developer experience (DX) across the platform.
- The maintainer tries to respond to bug reports as quickly as possible. While there are no guarantees, the typical turnaround time for a bug fix is less than 24 hours.
- Frequent releases deliver new features and enhancements to users more quickly. Meanwhile, the release interval of Decap CMS has been irregular and often long, sometimes exceeding 2 months.
- Many of our minor releases address one or more Netlify/Decap CMS issues, giving you even more reasons to switch from the legacy predecessor.
- Offers a modern, intuitive user interface that utilizes the full viewport,[^178] inspired in part by the Netlify CMS v3 prototype.[^1][^211][^212][^213][^214]
- Provides immersive dark mode.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
- Users can easily manage content on-the-go with mobile and tablet support.[^18][^215]
- For a smoother experience, we even go beyond responsive design with optimized navigation, floating action buttons, view transitions, larger buttons, and other tweaks. We’ll continue to fully optimize the app for small screens and touch devices.
- If you’re already signed in on your desktop, open the Account menu in the top right corner of the CMS, click Sign In with Mobile, and scan the QR code for passwordless sign-in. Your settings will be automatically copied.
- Made with Svelte, not React, means we can spend more time on UX rather than tedious state management. It also allows us to avoid common fatal React application crashes.[^113][^129] Best of all, Svelte offers great performance.
- Other crashes in Netlify/Decap CMS are also irrelevant to us, making Sveltia CMS much more stable.[^112][^203][^204][^260] Netlify/Decap CMS continues to receive crash reports on a daily basis, with no effective solution in sight.
- We build our own UI component library, including custom dialogs, to ensure optimal usability without compromising accessibility.[^277][^196][^205][^206][^207][^208][^209][^210]
- Users can personalize the application with various settings, including appearance and language. Developer Mode can also be enabled, which enables certain features and displays the CMS version number.[^270]
- Never miss out on the latest features and bug fixes by being notified when an update to the CMS is available.[^31] Then update to the latest version with a single click.[^66]
Better performance
- Built completely from scratch with Svelte instead of forking React-based Netlify/Decap CMS. The app starts fast and stays fast with no virtual DOM overhead. Note that Svelte is a compiler and Sveltia CMS is framework-agnostic; it’s served as a vanilla JavaScript bundle.
- Small footprint: The bundle size is less than 500 KB when minified and brotlied, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.5 MB) and Static CMS (2.6 MB).[^57] This significant reduction in size is thanks to the combination of Svelte 5 and Vite. Sveltia CMS also dynamically loads certain dependencies only when needed, further reducing the initial load time.
- Uses the GraphQL API for GitHub and GitLab to quickly fetch content at once, so that entries and assets can be listed and searched instantly[^32][^65] (the useless
searchconfiguration option is therefore ignored). It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation fields.[^14] - Saving entries and assets to GitHub is also much faster thanks to the GraphQL mutation.
- The Gitea/Forgejo backend is also faster because it utilizes an efficient API method introduced in Gitea 1.24 and Forgejo 12.0.
- Our local repository workflow utilizes the modern File System Access API to read and write files natively through the web browser, rather than using a slow, ad hoc REST API through a proxy server.
- Sorting, filtering and grouping of entries is done instantly without reloading the entire content.
- Uses caching, lazy loading and infinite scrolling techniques. A list of repository files is stored locally for faster startup and bandwidth savings.
- Thumbnails of assets, including videos and PDF files, are generated and cached for faster rendering of the Asset Library and other parts of the CMS.[^39][^38]
- No typing lag on input fields, especially within nested lists and objects.[^77]
- The entry preview doesn’t use an
<iframe>by default because it’s a performance overhead.[^179]
Better productivity
We’ve made various improvements to help you get your work done faster and more efficiently:
- Developers can work with a local Git repository without any additional configuration or proxy server, resulting in a streamlined workflow and improved performance.[^26]
- It also avoids a number of issues, including potential security risks,[^158][^282] a 30 MB file size limit,[^51] an unknown error with
publish_mode,[^75] and an unusedlogo_url.[^49] - When you delete an entry or an asset file, the empty folder that contains it is also deleted, so you don’t have to delete it manually.
- It also avoids a number of issues, including potential security risks,[^158][^282] a 30 MB file size limit,[^51] an unknown error with
- Provides a smoother user experience in the Content Editor:
- Users can upload multiple files at once to File/Image fields when the
multipleoption is enabled.[^239] - Uploading files can be done with drag and drop.[^20]
- Users can translate entry fields with one click using an integrated translation service without having to leave the CMS.
- A local backup of an entry draft is automatically created without interruption by a confirmation dialog, which annoys users and can cause a page navigation problem if dismissed.[^106] The backup can then be reliably restored without unexpected overwriting.[^85]
- Click once (the Save button) instead of twice (Publish > Publish now) to save an entry. Or just hit the
Ctrl+S(Windows/Linux) orCommand+S(macOS) key to save your time. - The editor closes automatically when an entry is saved. This behaviour can be changed in the application settings.
- Users can upload multiple files at once to File/Image fields when the
- Thanks to the built-in image optimizer, there’s no need for an external application to convert or resize images before uploading them.[^199][^200]
- Users can delete multiple entries and assets at once.
- Users can manage content on-the-go with mobile and tablet support.[^18][^215] This is especially useful for content editors who need to make quick updates while away from their desks.
- Instant full-text search with results sorted by relevance helps you find entries faster. In Netlify/Decap CMS, you often won’t get the results you expect.
- Some keyboard shortcuts are available for faster editing.
Better security
- Avoids vulnerabilities in dependencies through constant updates, Dependabot alerts,
pnpm audit, and frequent releases, unlike Netlify/Decap CMS where a number of high severity vulnerabilities remain unaddressed for a long time.[^33][^313]- We also use the
cooldownoption forncuand theminimumReleaseAgeoption forpnpmto avoid upgrading to a version that was just released. These options help protect against npm supply chain attacks.
- We also use the
- The unpatched XSS vulnerability in Decap CMS does not affect Sveltia CMS, as our entry preview implementation is completely different.
- However, the Markdown widget was potentially vulnerable to XSS attacks because the
sanitize_previewoption was set tofalseby default for compatibility with Netlify/Decap CMS. This behaviour is documented and is not a bug, but it’s definitely not secure. In Sveltia CMS 0.105.0, we changed the default value totrue, assuming that most users would prefer security over compatibility.
- However, the Markdown widget was potentially vulnerable to XSS attacks because the
- Our local repository workflow does not require a proxy server. This reduces attack surfaces by eliminating the possibility of compromised dependencies[^158] and unauthorized API access.[^282]
- Thanks to pnpm, Vite, GitHub Actions and npm package provenance, our release process is fast, reliable and transparent. This setup makes it easy to verify the integrity of published code and assets. It also helps us avoid errors that can occur with manual build steps.[^264]
- We have enabled trusted publishing and 2FA for package publishing.
- We have created a security policy.
- We have documented how to set up a Content Security Policy for the CMS to prevent any unexpected errors or otherwise insecure configuration.[^108]
- The
unsafe-evalandunsafe-inlinekeywords are not needed in thescript-srcCSP directive.[^34] - The
same-originreferrer policy is automatically set with a<meta>tag. - Sveltia CMS has a secure context requirement that forces the site content, including the CMS configuration file, to be served over HTTPS.
- GitHub commits are automatically GPG-signed and marked as verified.[^144]
Better accessibility
- Improved keyboard handling lets you efficiently navigate through UI elements using the Tab, Space, Enter and arrow keys.[^17][^67]
- Comprehensive WAI-ARIA support enables users who rely on screen readers such as NVDA and VoiceOver.[^228] An announcement is read out when you navigate to another page.
- The rich text editor is built with Lexical, which is said to follow accessibility best practices. The Dragon NaturallySpeaking support is enabled.
- Ensures sufficient contrast between the foreground text and background colours.
- Enabled and disabled buttons can be clearly distinguished.[^105]
- Links are underlined by default to make them easier to recognize. This behaviour can be changed in the Accessibility Settings if you prefer.
- Honours your operating system’s reduced motion and reduced transparency settings. Support for high contrast mode will be added later.
- Browser console logs for developers are readable in either light or dark mode.[^116]
- We’ll continue to test and improve the application to meet WCAG 2.2.
Better installation
- Sveltia CMS is built with Svelte, and we only publish compiled, minified vanilla JavaScript bundles. No dependencies will be installed when you install the app with npm, meaning:
- No React compatibility issues that might prevent developers from upgrading a project for many months.[^177]
- No peer dependency conflicts mainly due to legacy third-party React UI libraries.[^175] We build the app using our own Svelte UI component library to reduce reliance on third parties.
- No build errors due to browser-unfriendly packages and other dependency issues.[^237][^292][^293]
- Some servers and frameworks are known to remove the trailing slash from the CMS URL (
/admin) depending on the configuration. In such cases, the config file is loaded from the proper URL (/admin/config.yml) instead of a regular relative URL (./config.yml=/config.yml), which results in a 404 Not Found error.[^107] - The robots
metatag is automatically added to HTML to prevent the admin page from being indexed by search engines.[^174] Developers are still encouraged to manually add<meta name="robots" content="noindex">toindex.html, as not all crawlers support dynamically added tags. However, our solution should at least work with Google in case you forget to do so. - Initializing the CMS twice (due to the incorrect or missing placement of
window.CMS_MANUAL_INIT) will not result in aNotFoundError.[^251] - Sveltia CMS automatically enables manual initialization when you import the JavaScript module, so you don’t need to have
window.CMS_MANUAL_INIT = truein your code. - We provide only one package,
@sveltia/cms, instead of many (decap-cms,decap-cms-app,decap-cms-coreand so on), which is simpler and less confusing.
Better configuration
- Sveltia CMS supports a JSON configuration file that can be generated for bulk or complex collections.[^60] A TOML configuration file is also supported.
- Also supports multiple configuration files to allow developers to modularize the configuration.[^197]
- We provide an up-to-date JSON schema for YAML/JSON configuration files, which enables autocomplete and validation in VS Code and other editors.[^253] If you use deprecated options in a supported code editor, you should receive a warning.
- Improved TypeScript support:
- We keep our type definitions for
CMS.init()and other methods complete, accurate, up-to-date and annotated.[^190][^191][^192][^193][^227] This makes it easier to provide a config object when manually initializing the CMS.
- We keep our type definitions for
- Config validation enhancements:
- Sveltia CMS has additional validation rules designed to prevent common misconfigurations that could lead to runtime errors:
- Common backend misconfigurations, such as an incorrect repository name or a missing OAuth client ID[^303]
- A mismatch between the
formatandextensionoptions for a collection - Invalid collection, collection file, field, variable type names (e.g. names containing
.or*) slugtemplates containing slashes- Mutually exclusive config options (e.g.
field,fieldsandtypeson List fields) collectionandfilereferences on Relation fields- Duplicate variable type names
- Unsupported widgets and options
- (more to come)
- The error messages include the specific collection, field, variable type and fields names, rather than indexes such as
collections[7].fields[9].types[1]. This helps you to quickly identify the problematic configuration. - There are no false error messages saying
should match case "color" schema. - There are no error messages that advise to use deprecated camel case options like
valueField.
- Sveltia CMS has additional validation rules designed to prevent common misconfigurations that could lead to runtime errors:
Better backend support
The GitHub, GitLab, Gitea/Forgejo and Test backends are available in Sveltia CMS. For performance reasons, we don’t plan to support other backends.
- Uses the GraphQL API where possible for better performance, as mentioned above. You don’t need to set the
use_graphqloption to enable it for GitHub and GitLab.[^65] - The Git branch name is automatically set to the repository’s default branch (
main,masteror whatever) if not specified in the configuration file, preventing data loading errors due to a hardcoded fallback tomaster.[^95][^27] If a branch name is specified, it works as expected.[^232] - It’s possible to disable automatic deployments by default or on demand to save costs and resources associated with CI/CD and to publish multiple changes at once.[^24]
- Users can quickly open the source file of an entry or asset in your repository via the 3-dot menu when Developer Mode is enabled.
- Service status checks are performed frequently and an incident notification is displayed prominently.
- Authentication improvements:
- We provide our own OAuth client for GitHub and GitLab.
- The external OAuth window will not get stuck on a blank page after signing in.[^300]
- Users can sign in directly with a Git-based backend using a personal access token (PAT) instead of going through the regular OAuth flow.[^258]
- The OAuth access token is automatically renewed when using PKCE authorization.[^224]
- GitLab-specific improvements:
- Implements the GraphQL API with proper authorization.[^290]
- Comes with background service status checking, just like GitHub.
- Supports Git LFS (documentation).[^231]
- Users won’t get a 404 Not Found error when you sign in to the GitLab backend.[^115]
- We implemented a workaround for a GraphQL complexity limit issue in GitLab 18.4.2, while Netlify/Decap CMS continued to suffer from the same problem.[^301] Our workaround was removed after GitHub 18.4.5 solved the underlying issue.
- Our Gitea/Forgejo backend is high-performing because it retrieves multiple entries at once. It also supports Git LFS (documentation). Additionally, the backend won’t cause 400 Bad Request errors due to the presence of
DRAFT_MEDIA_FILESin file paths.[^222] - Unlike Netlify/Decap CMS, Sveltia CMS does not have a hardcoded API request timeout of 60 seconds, which can lead to unexpected errors when working with large files or slow networks.[^304] Though users may still experience timeouts due to server-side limitations, at least the client-side won’t impose an arbitrary limit.
- Features the all-new local repository workflow for a better DX. See the productivity section above.
- An indicator is displayed in the account menu when using the local repository workflow.[^302]
- Developers can select the local and remote backends while working on a local server.
- The Test backend saves entries and assets in the browser’s origin private file system (OPFS) so that changes are not discarded when the browser tab is closed or reloaded.[^194] The persistent storage support works with all modern browsers except Safari.
- Commit message template supports the
{{author-email}}template tag to include the author’s email address. - API error messages are displayed in a user-friendly manner instead of generic messages like
Failed to fetch.[^309]
Better i18n support
Sveltia CMS has been built with a multilingual architecture from the very beginning. You can expect first-class internationalization (i18n) support, as it’s required by clients of maintainer @kyoshino, who himself was a long-time Japanese localizer for Mozilla and currently lives in the most diverse city in the world where 150+ languages are spoken.
- Configuration
- The i18n limitations in Netlify/Decap CMS do not apply to Sveltia CMS:
- File collections support multiple files/folders i18n structures.[^87] To enable it, simply use the
{{locale}}template tag in thefilepath option, e.g.content/pages/about.{{locale}}.jsonorcontent/pages/{{locale}}/about.json. For backward compatibility, the globalstructureoption only applies to folder collections, and the default i18n structure for file collections remains single file. - The List and Object widgets support the
i18n: duplicatefield configuration so that changes made with these widgets are duplicated between locales.[^7][^68] Thei18nconfiguration can normally be used for the subfields.
- File collections support multiple files/folders i18n structures.[^87] To enable it, simply use the
- Gives more control over entry file paths:
- The new
multiple_folders_i18n_rooti18n structure allows to have locale folders below the project root:/<locale>/<folder>/<path>.<extension>.[^182] - The new
omit_default_locale_from_filenamei18n option allows to exclude the default locale from filenames. This option applies to folder collections with themultiple_filesi18n structure enabled, as well as to file collection items with thefilepath ending with.{{locale}}.<extension>, aiming to support Zola’s multilingual sites. (Discussion) - Entry-relative media folders can be used in conjunction with the
multiple_foldersi18n structure.[^21]
- The new
- Entry slug enhancements:
- It’s possible to use a random UUID for an entry slug, which is a good option for locales that write in non-Latin characters.
- It’s possible to localize entry slugs while linking the localized files,[^80] thanks to the support for Hugo’s
translationKey.[^81] - When the
clean_accentsoption is enabled for entry slugs, certain characters, such as German umlauts, will be transliterated.[^99]
- The
requiredfield option accepts an array of locale codes in addition to a boolean, making the field required for a subset of locales when i18n support is enabled. For example, if only English is required, you could writerequired: [en]. An empty array is equivalent torequired: false. - The
{{locale}}template tag can be used in thepreview_pathcollection option to provide site preview links for each language.[^63] - It’s possible to embed the locale code in an entry by using
widget: hiddenalong withdefault: '{{locale}}'.[^101] - The
value_fieldRelation field option can contain a locale prefix like{{locale}}/{{slug}}, which will be replaced with the current locale. It’s intended to support i18n in Astro. (Discussion) - The collection filters are applied correctly regardless of the i18n structure.[^291]
- The i18n limitations in Netlify/Decap CMS do not apply to Sveltia CMS:
- User interface
- Eliminates UI confusion: The Preview Pane can be displayed without toggling i18n in the Content Editor. Both panes are scrollable. There is no condition where both panes are edited in the same language at the same time.
- Users can easily switch between locales while editing by clicking a button instead of a dropdown list when there are less than 5 locales.
- Language labels appear in human-readable display names instead of ISO 639 language codes because it’s not easy for everyone to recognize
DEas German,NLas Dutch,ZHas Chinese, and so on.
- Content editing
- Integrates translation services to allow translation of text fields from another locale with one click.
- The Content Editor supports RTL scripts such as Arabic, Hebrew and Persian.[^146]
- It’s possible to disable non-default locale content.[^15]
- Boolean, DateTime, List and Number fields in the entry preview are displayed in a localized format.
- Boolean fields are updated in real time between locales like other widgets to avoid confusion.[^35]
- Relation fields with i18n enabled won’t trigger a change in the content draft status when you start editing an existing entry.[^84]
- Solves problems with Chinese, Japanese and Korean (CJK) IME text input in the rich text editor for the Markdown widget.[^54]
- Raises a validation error instead of failing silently if the
single_filestructure is used and a required field is not filled in any of the locales.[^55] - Fields in non-default locales are validated as expected.[^13]
- No internal error is thrown when changing the locale.[^103]
- Duplicating an entry duplicates all locale content, not just the default locale.[^170]
- Copying Markdown from another locale using the menu works as expected.[^236]
Better collections
- Configuration
- Provides some new options, including:
icon: Choose a custom icon for each collection.[^3]- The option can also be used for individual files within a file collection. The specified icon will then appear in the file list.
thumbnail: Specify the field name for a thumbnail displayed on the entry list, likethumbnail: featuredImage.- A nested field can be specified using dot notation, e.g.
heroImage.src. - A wildcard in the field name is also supported, e.g.
images.*.src. - Multiple field names can be specified as an array for fallback purpose, e.g.
[thumbnail, cover]. - Occasionally, you may not have suitable images for thumbnails. For example, your images may have subtle differences or varied aspect ratios. In that case, you can disable the thumbnail with
thumbnail: false. - If this option is omitted, any non-nested, non-empty Image or File field will be used.[^173] Sveltia CMS doesn’t have hardcoded inference fields.[^130]
- A nested field can be specified using dot notation, e.g.
limit: Specify the maximum number of entries that can be created in a folder collection.[^185]divider: Add dividers to the collection list.
- Enhancements to the entry
filteroption for folder collections:- Boolean
valueworks as expected.[^93] valueacceptsnullto match an undefined field value.valueaccepts an array to provide multiple possible values.[^151]patterncan be used instead ofvalueto provide a regular expression, just like theview_filterscollection option.[^153]
- Boolean
- Enhancements to summary string transformations:
- Transformations can be used in more places than just the collection
summary:- The
slug,pathandpreview_pathcollection options[^29] - The
summaryfield option for the List and Object widgets
- The
- The
defaulttransformation accepts a template tag like{{fields.slug | default('{{fields.title}}')}}, making it possible to fall back to a different field value. (Discussion) - The
datetransformation supports the time zone argument. The only available value isutc, which converts a date to UTC. This is useful if the specified DateTime field is local, but you want to force UTC in the entry slug, e.g.{{date | date('YYYYMMDD-HHmm', 'utc')}}. (Discussion) - The
datetransformation returns an empty string if an invalid date is given.[^176] - Multiple transformations can be chained like
{{title | upper | truncate(20)}}.
- Transformations can be used in more places than just the collection
- Enhancements to file collections:
- Sveltia CMS supports singletons, a simple form of a file collection.[^233]
- File collections support files without extensions.[^255] This is useful for editing site deployment configuration files, such as
_headersand_redirects. - Each file in a file collection has the
formatandfrontmatter_delimiteroptions, which can be used to specify the file format, making it possible to haveyaml-frontmatter,toml-frontmatterandjson-frontmatterside by side.[^218]
- The
createoption for folder collections defaults totrue, providing a better out-of-the-box experience. - The collection
labeldefaults to thenamevalue according to the Decap CMS document, while Netlify/Decap CMS actually throws a configuration error if thelabeloption is omitted. - Nested fields (dot notation) can be used in the
pathoption for a folder collection, e.g.{{fields.state.name}}/{{slug}}.[^62] - Markdown is supported in the
descriptioncollection option.[^79] Bold, italic, strikethrough, code and links are allowed. - The collection
foldercan be an empty string (or.or/) if you want to store entries in the root folder. This supports a typical VitePress setup.
- Provides some new options, including:
- Entry slugs
- It’s possible to use a random UUID for an entry slug.
- Entry slugs are editable.[^184]
- To allow users to explicitly edit the entry slug in an initial entry draft, add
{{fields._slug}}to theslugcollection option. This will display a special slug editor UI that looks like a standard string field, but the value will be used as the entry slug. - Once an entry is saved, users can edit the slug via the 3-dot menu in the Content Editor.
- To allow users to explicitly edit the entry slug in an initial entry draft, add
- Entry slugs are localizable.[^80]
- Use
{{fields._slug | localize}}to make the slug field editable and localizable.
- Use
- Slug generation is fail-safe: If a slug cannot be determined from entry content, part of a random UUID is used instead of throwing an error or filling in with arbitrary string field values.[^133]
- If a collection only has the Markdown
bodyfield, an entry slug will be generated from a header in thebody, if exists. This supports a typical VitePress setup. - Entry slug template tags support transformations just like summary string template tags.[^29] For example, you can use
{{fields.date | date('YYYY-MM-DD')}}to generate a slug like2025-01-23from a DateTime field. - Single quotes (apostrophes) in a slug will be replaced with
sanitize_replacement(default: hyphen) rather than being removed.[^52] - The global
slugoption accepts thetrimoption to remove leading and trailing replacement characters, such as hyphens, from an entry slug. The default value istrue. Set tofalseto keep them. - The maximum number of characters for an entry slug can be set with the new
slug_lengthcollection option to avoid deployment errors with Netlify or other platforms.[^25] - Setting the collection
pathdoesn’t affect the entry slugs stored with the Relation widget.[^137]
- Entry listing
- The default sort field and direction can be specified.[^172]
- The default filter and group can also be specified in the same way as with Static CMS.[^269]
- Sorting entries by a DateTime field works as expected.[^110]
- Entry grouping and sorting can work together. For example, it’s possible to group by year and then sort by year if configured properly.
- The
sortable_fieldsoption accepts a specialslugvalue to allow sorting by entry slugs. - Index file inclusion allows users to edit Hugo’s special
_index.mdfile, including localized ones like_index.en.md, within a folder collection.[^201] If theindex_fileoption is not defined, these files will be hidden in a folder collection unless thepathoption is configured to end with_indexand theextensionismd.[^120] - A console error won’t be thrown when a collection doesn’t have the
titlefield.[^152] In that case, an entry summary will be generated from a header in the Markdownbodyfield, if exists, or from the entry slug, so the summary will never be an empty.[^161] This supports a typical VitePress and Docusaurus setup.[^230] - If there was an error while parsing an entry file, such as duplicate front matter keys, it won’t show up as a blank entry, and a clear error message will be displayed in the browser console.[^121]
- A single file can be used for more than one item in a file collection.[^127]
- User interface
- The collection list displays the number of items in each collection.
- Users can select multiple entries and delete them at once.
- In an entry summary, basic Markdown syntax used in the title, including bold, italic and code, are parsed as Markdown. HTML character references (entities) are also parsed properly.[^69]
- If you update an entry field that appears in the collection’s
summary, such astitle, the entry list displays an updated summary after you save the entry.[^159] - Thumbnails of entries are displayed not only in the grid view but also in the list view, making it easier to navigate.
- If entries don’t have an Image field for thumbnails, the entry list will only be displayed in the list view, because it doesn’t make sense to show the grid view.[^143]
- Assets stored in a collection media folder can be displayed next to the entries.
- The New Entry button won’t appear when a developer accidentally sets the
create: trueoption on a file collection because it’s useless.[^89] - The Delete Entry button won’t appear when a developer accidentally sets the
delete: trueoption on a file collection because the preconfigured files should not be deleted.
Better content editing
- Required fields, not optional fields, are marked for efficient data entry.
- Users can revert changes to all fields or a specific field.
- If you revert changes and there are no unsaved changes, the Save button is disabled as expected.[^118]
- The new
readonlyfield option makes the field read-only. This is useful when adefaultvalue is provided and the field should not be editable by users.[^223] The option defaults tofalseexcept for the UUID widget, where it defaults totrue. - Fields with validation errors are automatically expanded if they are part of nested, collapsed objects.[^40]
- A full regular expression, including flags, can be used for the widget
patternoption.[^82] For example, if you want to allow 280 characters or less in a multiline text field, you could write/^.{0,280}$/s(but you can now use themaxlengthoption instead.) - A long validation error message is displayed in full, without being hidden behind the field label.[^59]
- Any links to other entries will work as expected, with the Content Editor being updated for the other.[^100]
- In the Boolean and Select widgets, you don’t have to update a value twice to re-enable the Save button after saving an entry.[^139]
datacan be used as a field name without causing an error when saving the entry.[^180]
Better content preview
- The Preview Pane comes with a minimal default style.[^168] It looks nice without a custom preview style or template.
- For better performance, the Preview Pane doesn’t use an
<iframe>unless a custom preview stylesheet is registered.[^179] - The Preview Pane displays all fields, including each label, making it easier to see which fields are populated.
- Entering a long value into a field will not cause the field label to disappear.[^254]
- Clicking a field in the Preview Pane focuses the corresponding field in the Edit Pane.[^41] It automatically expands when collapsed.
- This is equivalent to the (misleading) visual editing feature introduced in Decap CMS 3.6.0, but our click-to-highlight feature is enabled by default; you don’t need to opt in with the
editor.visualEditingcollection option. We don’t plan to support this option because it’s confusing, unnecessary and undocumented. (Plus, why camel case?)
- This is equivalent to the (misleading) visual editing feature introduced in Decap CMS 3.6.0, but our click-to-highlight feature is enabled by default; you don’t need to opt in with the
- The Preview Pane doesn’t cause a scrolling issue.[^136]
- The Preview Pane doesn’t crash with a Minified React error.[^186]
- Provides better scroll synchronization between the panes when editing or previewing an entry.[^92]
- Developers can hide the preview of a specific field using a new field option:
preview: false.[^126] - See below for widget-specific enhancements, including support for variable types[^42] and YouTube videos.
Better data output
- Keys in generated JSON/TOML/YAML content are always sorted by the order of configured fields, making Git commits clean and consistent.[^86]
- Netlify/Decap CMS often, but not always, omits optional and empty fields from the output.[^154] Sveltia CMS aims at complete and consistent data output — it always saves proper values, such as an empty string, an empty array or
null, instead of nothing (undefined), regardless of therequiredfield option.[^45][^46][^44][^157]- In other words, in Sveltia CMS,
required: falsemakes data input optional, but doesn’t make data output optional. - To omit empty optional fields from data output, use
omit_empty_optional_fields: truein the data output options. This is useful if you have data type validations that expectundefined.[^156]
- In other words, in Sveltia CMS,
- JSON/TOML/YAML data is saved with a new line at the end of the file to prevent unnecessary changes being made to the file.[^11]
- Leading/trailing whitespaces in text-type field values are automatically removed when you save an entry.[^37] No option is required to trim the values.[^275]
- YAML string folding (maximum line width) is disabled, mainly for framework compatibility.[^119]
- A standard time is formatted as
HH:mm:ssinstead ofHH:mmfor framework compatibility. - DateTime field values in ISO 8601 format are stored in native date/time format instead of quoted strings when the data output is TOML.[^147]
- Provides JSON/YAML format options as part of the data output options, including indentation and quotes.[^155][^9]
- It’s impossible to inject front matter through the
bodyfield.[^268]
Better widgets
Sveltia CMS supports all the built-in widgets available in Netlify/Decap CMS. We have improved these widgets significantly while adding some new ones.
- Boolean
- A required Boolean field with no default value is saved as
falseby default, without raising a confusing validation error.[^45] - An optional Boolean field with no default value is also saved as
falseby default, rather than nothing.[^46]
- A required Boolean field with no default value is saved as
- Code
- More than 300 languages are available, thanks to Prism’s extensive language support.
- The language switcher always appears in the user interface, so it’s easy to spot and change the selected language.
- Dynamic loading of language modes work as expected.[^198]
- A Code field under a List field work as expected, saving both code and language.[^181]
- A wrong initial value will not cause a crash with a
TypeError.[^257]
- Color
- The widget doesn’t cause scrolling issues.[^128]
- The preview shows both the RGB(A) hex value and the
rgb()function notation.
- DateTime
- A DateTime field doesn’t trigger a change in the content draft status when you’ve just started editing a new entry.[^90]
- User’s local time is not saved in UTC unless the
picker_utcoption istrue.[^150] - The widget doesn’t throw a
RangeErrorfor formatting days of the month.[^250]
- Hidden
- The
defaultvalue supports the following template tags:{{locale}}: The current locale code.[^101]{{datetime}}: The current date/time in ISO 8601 format.[^102]{{uuid}},{{uuid_short}}and{{uuid_shorter}}: A random UUID or its shorter version, just like the slug template tags.[^12]{{author-email}},{{author-login}}and{{author-name}}: The signed-in user’s email, login name and display name, respectively.[^305]
- The
defaultvalue is saved when you create a file collection item, not just a folder collection item.[^78]
- The
- List
- It’s possible to edit data files with a top-level list using the new
rootoption.[^148] - The
minandmaxoptions can be used separately. You don’t need to specify both to use either option.[^145] - The Add Item button appears at the bottom of the list when the
add_to_topoption is nottrue, so you don’t have to scroll up each time to add new items. - A list item comes with a menu that allows users to duplicate the item, insert a new item above/below it, or remove it.[^187]
- Users can expand or collapse the entire list, while the Expand All and Collapse All buttons allow you to expand or collapse all items in the list at once.[^164]
- A required List field with no subfield or value is marked as invalid.[^43] No need to set the
minandmaxoptions for therequiredoption to work. - An optional List field with no subfield or value is saved as an empty array, rather than nothing.[^44]
- An optional List field won’t populate an item by default when the subfield has the
defaultvalue.[^162] - A simple List field with no subfields is displayed as a multiline text field,[^219] where users can use spaces[^50] and commas[^220] for list items. A comma is no longer treated as a list delimiter.
- Users can preview variable types without having to register a preview template.[^42]
- It’s possible to omit
fieldsin a variable type object.[^163] In that case, only thetypeKey(default:type) is saved in the output. - The new
thumbnailoption allows developers to specify an Image field name for the list item thumbnail. Thumbnails are displayed alongside thesummaryin the collapsed item view. (Discussion) - A collapsed List field will not display a programmatic summary like
List [ Map { "key": "value" } ]if thesummaryoption is not set.[^183] - The
allow_removeandallow_reorderoptions can be used to prevent users from removing items and reordering them, respectively.[^272]
- It’s possible to edit data files with a top-level list using the new
- Map
- A search bar enables users to quickly locate a specific place on the map.[^252]
- With the Geolocation API, users can get their current location with one click.
- The value can be cleared by clicking the Clear button.
- The map’s zoom level is adjusted more intuitively using pinch gestures.
- The map looks good in dark mode.
- Markdown
- The rich text editor is built with the well-maintained Lexical framework, which solves various issues with a Slate-based editor in Netlify/Decap CMS,[^235] including fatal application crashes,[^71][^72][^73][^111] lost formatting when pasting,[^124][^311] an extra line break when pasting,[^169] extra HTML comments when pasting,[^229] backslash injections,[^53] dropdown visibility,[^70] and text input difficulties with IME.[^54]
- For better security, the
sanitize_previewoption defaults totruesince Sveltia CMS 0.105.0. - The default editor mode can be set by changing the order of the
modesoption.[^58] If you want to use the plain text editor by default, addmodes: [raw, rich_text]to the field configuration. - A Markdown field plays well with a variable type List field.[^202]
- The bullet list marker is a hyphen (
-) rather than an asterisk (*), which is the comment form’s default behaviour on GitHub and GitLab.[^296] - A combination of bold and italic doesn’t create a confusing 3-asterisk markup.[^160] In our editor, bold is 2 asterisks and italic is an underscore.
- When deleting a linked text, the link is removed cleanly without leaving behind any unwanted characters.[^298]
- Bare URLs are rendered as clickable links in the preview.[^312]
- An editor component can be removed with a single click on the Remove button.[^310]
- The built-in
imagecomponent can be inserted with a single click. - The built-in
imagecomponent allows users to add, edit or remove a link on an image.[^171] To disable this feature, addlinked_images: falseto the Markdown field options. - It’s possible to paste/drop local/remote images into the rich text editor to insert them as expected. Note: Pasting multiple images is not supported in Firefox. In Netlify/Decap CMS, pasting an image may cause the application to crash.[^284]
- The built-in
code-blockcomponent is implemented just like a blockquote. You can simply convert a normal paragraph into a code block instead of adding a component. - Code in a code block in the editor can be copied as expected.[^165]
- Language-annotated code block doesn’t trigger unsaved changes.[^189]
- Soft line breaks are rendered as hard line breaks in the Preview Pane.
- Uploaded images will not disappear while editing an entry.[^278][^294]
- Number
- If the
value_typeoption isint(default) orfloat, therequiredoption isfalse, and the value is not entered, the field will be saved asnullinstead of an empty string.[^157] Ifvalue_typeis anything else, the data type will remain a string.
- If the
- Object
- Sveltia CMS offers two ways to have conditional fields in a collection:[^30]
- The Object widget supports variable types (the
typesandtypeKeyoptions) just like the List widget.[^226] - An optional Object field (
required: false) can be manually added or removed with a checkbox.[^88] If unadded or removed, the required subfields won’t trigger validation errors,[^16] and the field will be saved asnull.
- The Object widget supports variable types (the
- Sveltia CMS offers two ways to have conditional fields in a collection:[^30]
- Relation
- Field options are displayed with no additional API requests.[^14] The confusing
options_lengthoption, which defaults to 20, is therefore ignored.[^76] - The widget reliably displays the selected option in the summary and all available options in the dropdown list.[^259]
slugcan be used forvalue_fieldto show all available options instead of just one in some situations.[^91]- Template strings with a wildcard like
{{cities.*.name}}can also be used forvalue_field.[^94] display_fieldsis displayed in the Preview Pane instead ofvalue_field.- The redundant
search_fieldsoption is optional in Sveltia CMS, as it defaults todisplay_fields,value_fieldor the collection’sidentifier_field, which istitleby default. - The
value_fieldoption is also optional in Sveltia CMS, as it defaults to{{slug}}(entry slugs). - A new item created in a referenced collection is immediately available in the options.[^138]
- A referenced DateTime field value is displayed in the specified format.[^221]
- It’s possible to refer to a List field with the
fieldoption, which produces a single subfield but does not output the subfieldnamein the data, using thevalue_field: cities.*.namesyntax. (Discussion) - Supports the
filtersoption to filter available options based on field values in the referenced collection.[^308] The implementation is compatible with Decap CMS.
- Field options are displayed with no additional API requests.[^14] The confusing
- Select
- It’s possible to select an option with value
0.[^56] labelis displayed in the Preview Pane instead ofvalue.
- It’s possible to select an option with value
- String
- When a YouTube video URL is entered in a String field, it appears as an embedded video in the Preview Pane. Check your site’s CSP if the preview doesn’t work.
- When a regular URL is entered in a String field, it appears as a link that can be opened in a new browser tab.
- Supports the
typeoption that acceptsurloremailas a value, which will validate the value as a URL or email. - Supports the
prefixandsuffixstring options, which automatically prepend and/or append the developer-defined value to the user-input value, if it’s not empty.
- Boolean, Number and String
- Supports the
before_inputandafter_inputstring options, which allow developers to display custom labels before and/or after the input UI.[^28] Markdown is supported in the value.- Compatibility note: In Static CMS, these options are implemented as
prefixandsuffix, respectively, which have different meaning in Sveltia CMS.
- Compatibility note: In Static CMS, these options are implemented as
- Supports the
- File and Image
- Provides a reimagined all-in-one asset selection dialog for File and Image fields.[^234]
- Field, entry, file, collection and global assets are listed on separate tabs for easy selection.[^19]
- A new asset can be uploaded by dragging & dropping it into the dialog.[^20]
- A URL can also be entered in the dialog.
- Integration with Pexels, Pixabay and Unsplash makes it easy to select and insert a free stock photo.[^8] More stock photo providers will be added in the future.
- Users can also simply drag and drop a file onto a File/Image field to attach it without having to open the Select File dialog.
- Supports the boolean
multipleoption, which can be set totrueto allow multiple file uploads.[^239]- When enabled, users can select and upload multiple files at once in the Select File dialog, as well as drag and drop multiple files onto the field. The field value will be an array of strings instead of a single string.
- The
minandmaxoptions are also available to limit the number of fil
- Provides a reimagined all-in-one asset selection dialog for File and Image fields.[^234]
