@sveltia/cms 0.20.0 → 0.21.0

package/README.md

@@ -1,6 +1,6 @@
 # Sveltia CMS
 
-Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and [Decap CMS](https://decapcms.org/). In some simple cases, migration is as easy as a single line of code change, although we’re still working on improving compatibility. The free, open source, UX-focused alternative to Netlify/Decap CMS is now in public beta — with more features to come.
+Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and [Decap CMS](https://decapcms.org/). In some simple cases, migration is as easy as a single line of code change, although we are still working on improving compatibility. The free, open source, UX-focused alternative to Netlify/Decap CMS is now in public beta — with more features to come.
 
 ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-1-20231124.webp)<br>
 
@@ -20,6 +20,18 @@ To achieve radical improvements in UX, performance, i18n and other areas, it was
 
 Our goal is to make it a viable successor to Netlify CMS, expand the Git-based headless CMS market, empower small businesses and individuals who need a simple yet powerful CMS solution, and showcase the huge potential of the Svelte framework.
 
+## Development status
+
+**Sveltia CMS is still in beta**, so please be careful when trying it out.
+
+While we are fixing reported bugs as fast as we can, the overall progress may be slower than you think. The thing is, it’s not just a personal project of [@kyoshino](https://github.com/kyoshino), but also involves different kinds of activities:
+
+- Ensuring maximum compatibility with existing versions of Netlify/Decap CMS
+- Tackling as many [issues reported to Netlify/Decap CMS](https://github.com/decaporg/decap-cms/issues) as possible (so far 75+ of them have been effectively solved in Sveltia CMS, with the goal of reaching 100 by GA)
+- Implementing our own enhancement ideas
+
+At this point **we hope to ship version 1.0 in Q3 2024**. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) for updates!
+
 ## Features
 
 We are working hard to create a **much better alternative to Netlify CMS** and Decap CMS by improving everything. Here’s what makes Sveltia CMS different. Look how serious we are!
@@ -34,7 +46,7 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 
 - Created and maintained by an [experienced UX engineer](https://github.com/kyoshino) who loves code, design and marketing. You can expect constant UX improvements across the platform.
 - Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
-- Comes with touch device support. While the UI is not yet optimized for small screens, large tablets like iPad Pro or Pixel Tablet should work well.
+- Comes with touch device support. While the UI is not yet optimized for small screens, large tablets like iPad Pro or Pixel Tablet should work well. Mobile support is planned after the 1.0 release.
 - Made with Svelte, not React, means we can spend more time on UX rather than tedious state management.
 - The screenshots above are worth a thousand words!
 - Read on to learn about many other enhancements, including performance, productivity, accessibility, service integrations, and an all-new Asset Library.
@@ -42,7 +54,7 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 ### Better performance
 
 - Built completely from scratch with Svelte instead of forking React-based Netlify/Decap CMS. The app starts fast and stays fast. The compiled code is vanilla JavaScript — you can use it with almost any framework.
-- Small footprint: The bundle size is less than 400 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS. And [no virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
+- Small footprint: The bundle size is less than 500 KB when minified and gzipped, which is much lighter than bloated Netlify CMS (1.5 MB) and Decap CMS (1.8 MB)[^57]. Sveltia CMS is free of technical debt and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
 - 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]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
 - Saving entries and assets to GitHub is also much faster thanks to the [GraphQL mutation](https://github.blog/changelog/2021-09-13-a-simpler-api-for-authoring-commits/).
 - A list of repository files is cached locally for faster startup and bandwidth savings.
@@ -52,11 +64,12 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 ### Better productivity
 
 - You can [work with a local Git repository](#working-with-a-local-git-repository) without any configuration or proxy server[^26].
-  - In addition to a streamlined workflow, it offers great performance because files are loaded natively through the browser rather than using an ad hoc API.
+  - In addition to a streamlined workflow, it offers great performance by loading files natively through the browser rather than using a slow, ad hoc API.
   - It also allows you to bypass the 30 MB file size limit[^51].
   - The `logo_url` defined in the configuration will be used[^49].
-- Click once (the Save button) instead of twice (Publish > Publish now) to save an entry.
-- The Entry Editor closes automatically when an entry is saved.
+- Eliminates some workflow disruptions in the Content Editor:
+  - Click once (the Save button) instead of twice (Publish > Publish now) to save an entry.
+  - The editor closes automatically when an entry is saved.
 - You can upload multiple assets at once. (See below)
 - You can delete multiple entries and assets at once.
 - Some keyboard shortcuts are available for faster editing. More to come!
@@ -77,9 +90,9 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 
 ### Better security
 
-- Avoids high/critical severity vulnerabilities through constant dependency updates and frequent releases[^34].
+- Avoids high/critical severity vulnerabilities through constant dependency updates and frequent releases[^33].
 - We have documented how to [set up a Content Security Policy](#setting-up-content-security-policy) for the CMS.
-- The `unsafe-eval` or `unsafe-inline` keywords are not needed in the `script-src` CSP directive[^33].
+- The `unsafe-eval` and `unsafe-inline` keywords are not needed in the `script-src` CSP directive[^34].
 - The `same-origin` referrer policy is automatically set with a `<meta>` tag.
 
 ### Better backend support
@@ -87,6 +100,7 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 - Uses the GraphQL API where possible for better performance, as mentioned above. You don’t need to set the `use_graphql` option to enable it for GitHub and GitLab.
 - The Git branch name is automatically set to the repository’s default branch (`main`, `master` or whatever) if not specified in the configuration file, preventing data loading errors due to a hardcoded fallback to `master`[^27].
 - You can [disable automatic deployments](#disabling-automatic-deployments) by default or on demand to save costs and resources associated with CI/CD and to publish multiple changes at once[^24].
+- The GitLab backend comes with background service status checking, just like GitHub.
 
 ### Better i18n support
 
@@ -96,9 +110,11 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 - [Integrates DeepL](#using-deepl-to-translate-entry-fields) to allow translation of text fields from another locale with one click.
 - You can [disable non-default locale content](#disabling-non-default-locale-content)[^15].
 - You can [use a random UUID for an entry slug](#using-a-random-id-for-an-entry-slug), which is a good option for locales that write in non-Latin characters.
-- Resolves the [limitations in the List and Object widgets](https://decapcms.org/docs/i18n/#limitations) so that changes made with these widgets will be duplicated between locales as expected when using the `i18n: duplicate` field configuration[^7].
+- Removes the [limitations in the List and Object widgets](https://decapcms.org/docs/i18n/#limitations) so that changes made with these widgets will be duplicated between locales as expected when using the `i18n: duplicate` field configuration[^7].
+- Raises a validation error instead of an internal error if the `single_file` structure is used and a required field is not filled in any of the locales[^55].
 - [Entry-relative media folders](https://decapcms.org/docs/collection-folder/#media-and-public-folder) can be used in conjunction with the `multiple_folders` i18n structure[^21].
 - Boolean fields are updated in real time between locales like other widgets to avoid confusion[^35].
+- Solves problems with Chinese, Japanese and Korean (CJK) [IME](https://en.wikipedia.org/wiki/Input_method) text input in the rich text editor for the Markdown widget[^54].
 
 ### Better collections
 
@@ -138,6 +154,8 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
   - An optional Object field can be manually added or removed. If unadded or removed, the required subfields won’t trigger validation errors[^16].
 - Relation
   - Field options are displayed with no additional API requests[^14]. The `options_length` property is therefore ignored.
+- Select
+  - It’s possible to select an option with value `0`[^56].
 - String
   - Supports the `type` property that accepts `url` or `email` as a value, which will validate the value as a URL or email.
   - Supports the `prefix` and `suffix` string properties, which automatically prepend and/or append the developer-defined value to the user-input value.
@@ -152,7 +170,7 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
     - [Collection-specific assets](#using-a-custom-media-folder-for-a-collection) are listed for easy selection, while all assets are displayed in a separate tab[^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].
+    - Integration with Pexels, Pixabay and Unsplash makes it easy to select and insert a free stock photo[^8]. More services will be added later.
 - String, Text and Markdown
   - A required field containing only spaces or line breaks will result in a validation error, as if no characters were entered.
 - New widgets
@@ -170,7 +188,7 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
     - Check your site’s [CSP](#setting-up-content-security-policy) if the preview doesn’t work.
   - Copy the public URL, file path, text data or image data of a selected asset to clipboard.
     - The file path starts with `/` as expected[^48].
-  - Edit plaintext assets, including SVG images.
+  - Edit plain text assets, including SVG images.
   - Replace existing assets.
   - Download one or more selected assets at once.
   - Delete one or more selected assets at once.
@@ -183,35 +201,29 @@ We are working hard to create a **much better alternative to Netlify CMS** and D
 
 ## Compatibility
 
-While it’s not our goal to recreate all the features found in Netlify/Decap CMS, we plan to maximize compatibility before the 1.0 release so that more users can migrate to our modern alternative. The table below is a summary of the current limitations of Sveltia CMS:
+We are trying to make Sveltia CMS as compatible as possible with Netlify/Decap CMS before the 1.0 release, so that more users can seamlessly switch to our modern, powerful alternative. However, some features will be omitted due to performance and other factors. The table below shows the current limitations of Sveltia CMS:
 
 | Feature | Status in Sveltia CMS |
 | --- | --- |
-| Installation | Installing with `npm` is not supported yet. |
-| Backends | Only the GitHub and GitLab backends are available. We’ll add the Test backend for our demo site, but Azure, Bitbucket and Gitea are unlikely to be supported due to performance limitations. Git Gateway will not be supported for the same reason; we may implement a performant alternative sometime later. |
-| UI Locales | Only English and Japanese are available at this time. |
-| Media Libraries | External media storage services are not supported yet. We will add support for Cloudinary and Uploadcare soon. We will not support deprecated Netlify Large Media. |
-| Workflow | Editorial Workflow and Open Authoring are not supported yet. |
-| Collections | Nested collections are not supported yet. |
-| Widgets | Custom widgets are not supported yet. [See below](#widget-limitations) for other limitations. |
-| Customizations | Custom previews, custom formatters, manual initialization and event subscriptions are not supported yet. |
+| Backends | Only the GitHub and GitLab backends are available. We’ll add the Test backend for our demo site, but Azure, Bitbucket and Gitea are unlikely to be supported due to performance limitations. Netlify Git Gateway will not be supported for the same reason; we may implement a performant alternative sometime later. |
+| Configuration | UI Locales are currently only available in English and Japanese. Comprehensive config validation is not yet implemented. |
+| Media Libraries | We will add support for Cloudinary and Uploadcare soon. Deprecated Netlify Large Media will not be supported. |
+| Workflow | Editorial Workflow and Open Authoring are not yet supported. |
+| Content Editor | Auto-saving a draft entry is not yet implemented. |
+| Collections | Nested collections are not yet supported. |
+| Widgets | Custom widgets are not yet supported. [See below](#widget-limitations) for other limitations. |
+| Customizations | Custom previews, custom formatters and event subscriptions are not yet supported. |
 
 ### Widget limitations
 
 | Widget | Status in Sveltia CMS |
 | --- | --- |
-| Code | Not supported yet. |
+| Code | Not yet supported. |
 | Date | Sveltia CMS has dropped the support for the deprecated widget following Decap CMS 3.0. Use the DateTime widget instead. |
-| DateTime | The `date_format` and `time_format` options with Moment.js tokens are not supported yet. Note: Decap CMS 3.1 has replaced Moment.js with [Day.js](https://day.js.org/); we’ll follow the change soon. |
-| File/Image | Field-specific media folders and media library options are not supported yet other than `media_library.config.max_file_size` for the default media library. |
-| Map | Not supported yet. |
-| Markdown | Editor components are not supported yet. Remark plugins will not be supported. |
-
-### Other features
-
-- Comprehensive config validation is not implemented yet.
-- Auto-saving a draft entry is not implemented yet.
-- [Backend health check](https://www.githubstatus.com/api) is not implemented yet.
+| DateTime | The `date_format` and `time_format` options with Moment.js tokens are not yet supported. Note: Decap CMS 3.1 has replaced Moment.js with [Day.js](https://day.js.org/); we’ll follow the change soon. |
+| File/Image | Field-specific media folders and media library options are not yet supported other than `media_library.config.max_file_size` for the default media library. |
+| Map | Not yet supported. |
+| Markdown | Editor components are not yet supported. Remark plugins will not be supported as they are not compatible with our Lexical-based rich text editor. |
 
 ## Roadmap
 
@@ -257,20 +269,22 @@ From Netlify CMS:
 
 ```diff
 -<script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
-+<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js" type="module"></script>
++<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js"></script>
 ```
 
 From Decap CMS:
 
 ```diff
 -<script src="https://unpkg.com/decap-cms@^3.0.0/dist/decap-cms.js"></script>
-+<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js" type="module"></script>
++<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js"></script>
 ```
 
 That’s it! You can open `https://[hostname]/admin/` as before to start editing. There is even no authentication process if you’ve already been signed in with GitHub or GitLab on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
 
 That said, we strongly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#working-with-a-local-git-repository) for how.
 
+For advanced users, we have also made the bundle available as an [npm package](https://www.npmjs.com/package/@sveltia/cms). You can install it by running `npm i @sveltia/cms` or `pnpm add @sveltia/cms` on your project. The [manual initialization](https://decapcms.org/docs/manual-initialization/) flow with the `init` method is the same as for Netlify/Decap CMS. Make sure to keep the dependency up to date!
+
 ### Updates
 
 Updating Sveltia CMS is transparent, unless you include a specific version in the `<script>` source URL. Whenever you (re)load the CMS, the latest version will be served via [UNPKG](https://unpkg.com/). The CMS also periodically checks for updates and notifies you when a new version is available. After the product reaches GA, you could use a semantic version range (`^1.0.0`) like Netlify/Decap CMS.
@@ -440,7 +454,7 @@ And combine the following policies depending on your Git backend and enabled int
 - GitLab: (If you’re running a self-hosted instance, you’ll also need to add the origin to these directives.)
   ```csp
   img-src https://gitlab.com https://secure.gravatar.com;
-  connect-src https://gitlab.com;
+  connect-src https://gitlab.com https://status-api.hostedstatus.com;
   ```
 - Pexels:
   ```csp
@@ -483,16 +497,6 @@ If you have image field(s) and expect that images will be inserted as URLs, you
 img-src 'self' blob: data: https://*;
 ```
 
-### Self-hosting the CMS
-
-Sveltia CMS is open source for sure! You can host it on your server rather than loading it from UNPKG, though it’s not recommended due to missing bug fixes. Simply copy the latest [`sveltia-cms.js`](https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js) file from the CDN, or build it yourself:
-
-1. Clone this Git repository.
-1. Run `pnpm install && pnpm build` at the project root.
-1. `sveltia-cms.js` will be generated under the `dist` directory.
-
-Importing the CMS as an npm package is not supported yet.
-
 ## Support & feedback
 
 Visit the [Discussions](https://github.com/sveltia/sveltia-cms/discussions) page on this GitHub repository and start a new discussion. Tell us about your use cases!
@@ -547,7 +551,7 @@ This software is provided “as is” without any express or implied warranty. W
 [^29]: Netlify/Decap CMS [#4783](https://github.com/decaporg/decap-cms/issues/4783)
 [^30]: Netlify/Decap CMS [#565](https://github.com/decaporg/decap-cms/issues/565)
 [^31]: Netlify/Decap CMS [#1045](https://github.com/decaporg/decap-cms/issues/1045), [#3353](https://github.com/decaporg/decap-cms/issues/3353)
-[^32]: Netlify/Decap CMS [#302](https://github.com/decaporg/decap-cms/issues/302), [#5549](https://github.com/decaporg/decap-cms/issues/5549)
+[^32]: Netlify/Decap CMS [#302](https://github.com/decaporg/decap-cms/issues/302), [#5549](https://github.com/decaporg/decap-cms/issues/5549), [#6034](https://github.com/decaporg/decap-cms/issues/6034)
 [^33]: Netlify/Decap CMS [#6513](https://github.com/decaporg/decap-cms/issues/6513)
 [^34]: Netlify/Decap CMS [#2138](https://github.com/decaporg/decap-cms/issues/2138)
 [^35]: Netlify/Decap CMS [#7086](https://github.com/decaporg/decap-cms/issues/7086)
@@ -565,7 +569,11 @@ This software is provided “as is” without any express or implied warranty. W
 [^47]: Netlify/Decap CMS [#2370](https://github.com/decaporg/decap-cms/issues/2370), [#5596](https://github.com/decaporg/decap-cms/issues/5596)
 [^48]: Netlify/Decap CMS [#5569](https://github.com/decaporg/decap-cms/issues/5569)
 [^49]: Netlify/Decap CMS [#5752](https://github.com/decaporg/decap-cms/issues/5752)
-[^50]: Netlify/Decap CMS [#4646](https://github.com/decaporg/decap-cms/issues/4646)
+[^50]: Netlify/Decap CMS [#4646](https://github.com/decaporg/decap-cms/issues/4646), [#7167](https://github.com/decaporg/decap-cms/issues/7167)
 [^51]: Netlify/Decap CMS [#6731](https://github.com/decaporg/decap-cms/issues/6731)
 [^52]: Netlify/Decap CMS [#7147](https://github.com/decaporg/decap-cms/issues/7147)
 [^53]: Netlify/Decap CMS [#5673](https://github.com/decaporg/decap-cms/issues/5673), [#6482](https://github.com/decaporg/decap-cms/issues/6482), [#6707](https://github.com/decaporg/decap-cms/issues/6707), [#6999](https://github.com/decaporg/decap-cms/issues/6999), [#7047](https://github.com/decaporg/decap-cms/issues/7047), [#7123](https://github.com/decaporg/decap-cms/issues/7123), [#7152](https://github.com/decaporg/decap-cms/issues/7152)
+[^54]: Netlify/Decap CMS [#1347](https://github.com/decaporg/decap-cms/issues/1347), [#4629](https://github.com/decaporg/decap-cms/issues/4629), [#6287](https://github.com/decaporg/decap-cms/issues/6287) — Decap 3.0 updated the Slate editor in an attempt to fix the problems, but the IME issues remain unresolved when using a mobile/tablet browser.
+[^55]: Netlify/Decap CMS [#4480](https://github.com/decaporg/decap-cms/issues/4480), [#6353](https://github.com/decaporg/decap-cms/issues/6353)
+[^56]: Netlify/Decap CMS [#6515](https://github.com/decaporg/decap-cms/issues/6515)
+[^57]: Netlify/Decap CMS [#328](https://github.com/decaporg/decap-cms/issues/328), [#3853](https://github.com/decaporg/decap-cms/issues/3853)