@sveltia/cms 0.38.0 → 0.38.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -78,7 +78,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
78
78
  ### Better performance
79
79
 
80
80
  - 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 any framework that can load static data files while building your website or application.
81
- - Small footprint: The bundle size is less than 550 KB when minified and gzipped, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.8 MB) and Static CMS (2.6 MB), even though we haven’t implemented some features yet[^57][^64].
81
+ - Small footprint: The bundle size is less than 500 KB when minified and gzipped, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.8 MB) and Static CMS (2.6 MB), even though we haven’t implemented some features yet[^57][^64].
82
82
  - The ongoing [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) upgrade is anticipated to deliver further performance improvements, including accelerated speed and even smaller bundle size (an estimated 100 KB reduction).
83
83
  - Sveltia CMS is free of technical debt and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
84
84
  - 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]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
@@ -106,6 +106,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
106
106
 
107
107
  - Improved keyboard handling lets you efficiently navigate through UI elements using the Tab, Space, Enter and arrow keys[^17][^67].
108
108
  - Comprehensive [WAI-ARIA](https://w3c.github.io/aria/) support enables users who rely on screen readers such as NVDA and VoiceOver.
109
+ - The rich text editor is built with [Lexical](https://lexical.dev/), which is said to follow accessibility best practices. The [Dragon NaturallySpeaking support](https://lexical.dev/docs/packages/lexical-dragon) is enabled.
109
110
  - Ensures sufficient contrast between the foreground text and background colours.
110
111
  - Enabled and disabled buttons can be clearly distinguished[^105].
111
112
  - Links are underlined by default to make them easier to recognize. This behaviour can be changed in the Accessibility Settings if you prefer.
@@ -182,7 +183,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
182
183
  - You can set the maximum number of characters for an entry slug with the new `slug_length` collection option[^25].
183
184
  - Entry listing
184
185
  - A folder collection filter with a boolean value works as expected[^93].
185
- - Hugo’s special `_index.md` files are ignored in a folder collection. You can still manage these files as part of a file collection if necessary[^120].
186
+ - Hugo’s special `_index.md` files are ignored in folder collections. You can still manage these files as part of a file collection if necessary[^120].
186
187
  - 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].
187
188
  - Sorting entries by a DateTime field works as expected[^110].
188
189
  - Assets stored in a [per-collection media folder](#using-a-custom-media-folder-for-a-collection) can be displayed next to the entries.
@@ -232,7 +233,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
232
233
  - You can enter spaces in a simple text-based List field[^50].
233
234
  - You can preview variable types without having to register a preview template[^42].
234
235
  - Markdown
235
- - The rich text editor is built with [Lexical](https://github.com/facebook/lexical) instead of [Slate](https://github.com/ianstormtaylor/slate), which solves various problems found in Netlify/Decap CMS, including fatal application crashes[^53][^70][^71][^72][^73][^111].
236
+ - The rich text editor is built with [Lexical](https://lexical.dev/) instead of [Slate](https://github.com/ianstormtaylor/slate), which solves various problems found in Netlify/Decap CMS, including fatal application crashes[^53][^70][^71][^72][^73][^111].
236
237
  - You can set the default editor mode by changing the order of the `modes` option[^58]. If you want to use the plain text editor by default, add `modes: [raw, rich_text]` to the field configuration.
237
238
  - Line breaks are rendered as line breaks in the preview pane according to GitHub Flavored Markdown.
238
239
  - Object
@@ -347,24 +348,24 @@ Missing any other features? Let us know by [filing an issue](https://github.com/
347
348
 
348
349
  ### Before the 1.0 release
349
350
 
350
- - Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
351
- - [Tackling more Netlify/Decap CMS issues](#development-status)
352
- - Broad automation test coverage (Vitest + Playwright)
353
351
  - [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) migration
354
- - Localization with the new, [Fluent](https://projectfluent.org)-powered `sveltia-i18n` library
355
- - Documentation
352
+ - Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
353
+ - Localization with the new [Fluent](https://projectfluent.org)-powered sveltia-i18n library
354
+ - Accessibility audit
355
+ - Developer documentation (implementation guide)
356
356
  - Marketing site
357
357
  - Live demo site
358
358
  - Official starter templates for the most popular frameworks, including SvelteKit and Next.js
359
+ - Broad automation test coverage (Vitest + Playwright)
359
360
 
360
361
  ### After the 1.0 release
361
362
 
362
- - Compatibility with Static CMS
363
- - Roles[^23]
364
- - Config editor[^10]
365
- - Mobile support[^18]
366
- - AI integrations
363
+ - Tackling more Netlify/Decap CMS issues, especially [top voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including MDX support[^122], roles[^23], mobile optimization[^18] and config editor[^10] — Some features are already implemented in Sveltia CMS
364
+ - Compatibility with Static CMS, a community fork of Netlify CMS
367
365
  - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
366
+ - AI integrations
367
+ - End-user documentation
368
+ - Contributor documentation
368
369
  - and more!
369
370
 
370
371
  ## Getting started
@@ -453,7 +454,7 @@ You can use Sveltia CMS with a local Git repository like Netlify/Decap CMS, but
453
454
  - You can remove `local_backend` from your configuration, as it will be ignored by Sveltia CMS.
454
455
  1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
455
456
  1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
456
- - Other Chromium-based browsers may also work. In Brave, you need to enable the File System Access API [with a flag](https://github.com/brave/brave-browser/issues/20563#issuecomment-1021567573).
457
+ - Other Chromium-based browsers may also work. Brave user? [See below](#enable-local-development-in-brave).
457
458
  1. Click “Work with Local Repository” and select the project’s root directory once prompted.
458
459
  - If you get an error saying “not a repository root directory”, make sure you’ve turned the folder into a repository with either a CUI ([`git init`](https://github.com/git-guides/git-init)) or GUI, and the hidden `.git` folder exists.
459
460
  - If you’re using Windows Subsystem for Linux (WSL), you may get an error saying “Can’t open this folder because it contains system files.” This is due to a limitation in the browser, and you can try some workarounds mentioned in [this issue](https://github.com/coder/code-server/issues/4646) and [this thread](https://github.com/sveltia/sveltia-cms/discussions/101).
@@ -466,6 +467,14 @@ Keep in mind that the local repository support doesn’t perform any Git operati
466
467
 
467
468
  Also, at this point, you have to reload the CMS to see the latest content after retrieving remote updates. This manual work will be unnecessary once the proposed `FileSystemObserver` API, which is being [implemented in Chromium](https://issues.chromium.org/issues/40105284) behind a flag, becomes available.
468
469
 
470
+ #### Enable local development in Brave
471
+
472
+ In the Brave browser, you must enable the File System Access API with an experiment flag to take advantage of local development.
473
+
474
+ 1. Open `brave://flags/#file-system-access-api` in a new browser tab.
475
+ 1. Click Default (Disabled) next to File System Access API and select Enabled.
476
+ 1. Relaunch the browser.
477
+
469
478
  ### Using a custom icon for a collection
470
479
 
471
480
  You can specify an icon for each collection for easy identification in the collection list. You don’t need to install a custom icon set because the Material Symbols font file is already loaded for the application UI. Just pick one of the 2,500+ icons:
@@ -1035,3 +1044,5 @@ This software is provided “as is” without any express or implied warranty. W
1035
1044
  [^120]: Netlify/Decap CMS [#2727](https://github.com/decaporg/decap-cms/issues/2727), [#4884](https://github.com/decaporg/decap-cms/issues/4884)
1036
1045
 
1037
1046
  [^121]: Netlify/Decap CMS [#7262](https://github.com/decaporg/decap-cms/issues/7262)
1047
+
1048
+ [^122]: Netlify/Decap CMS [#1776](https://github.com/decaporg/decap-cms/issues/1776), [#2064](https://github.com/decaporg/decap-cms/issues/2064), [#7158](https://github.com/decaporg/decap-cms/issues/7158), [#7259](https://github.com/decaporg/decap-cms/issues/7259)