@sveltia/cms 0.6.2 → 0.7.0

package/README.md

@@ -14,7 +14,9 @@ Sveltia CMS is a Git-based lightweight headless CMS under development as a drop-
 
 ## Motivation
 
-Sveltia CMS was born in November 2022, when the development of Netlify CMS had been at a standstill for more than half a year. [@kyoshino](https://github.com/kyoshino)’s clients wanted to replace their Netlify CMS instances mainly to get better internationalization support. Sveltia CMS was built from the ground up to take i18n into account in every corner of the product, while also striving for better UX, performance and productivity. Another goal of the project is to showcase the power of [Svelte](https://svelte.dev/), a modern UI library for creating web applications with less code.
+Sveltia CMS was born in November 2022, when the development of Netlify CMS had been stalled for over six months. [@kyoshino](https://github.com/kyoshino)’s clients were looking to replace their Netlify CMS instances, mainly to get better internationalization (i18n) and multilingual support. Built from the ground up, Sveltia CMS successfully incorporates i18n into every single corner of the product, while striving to radically improve UX, performance and productivity.
+
+Our goal is to expand the Git-based headless CMS market to empower small businesses and individuals who don’t need or can’t afford a (No)SQL database to manage their content. The project also showcases the power of [Svelte](https://svelte.dev/), a modern UI library for creating web applications with less code.
 
 ## Features
 
@@ -30,19 +32,21 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 
 - Ready to replace Netlify/Decap CMS _in some casual use case scenarios_ by updating one single line of code.
 - Existing [configuration files](https://decapcms.org/docs/configuration-options/) can be reused as is.
-- Various features are still missing though; [see the compatibility chart below](#compatibility) for details.
+- Various features are still missing though — [see the compatibility chart below](#compatibility) for details.
 
 ### Better UX
 
-- Offering a modern, intuitive UI, with some inspiration from the Netlify/Decap CMS v3 prototype[^1].
+- Created by an [experienced UX engineer](https://github.com/kyoshino) who loves code and design.
+- Offering a modern, intuitive UI, with some inspiration from the Netlify CMS v3 prototype[^1].
 - Immersive dark mode[^2].
 - The screenshots above are worth a thousand words!
 
 ### Better performance
 
-- Built completely from scratch with Svelte rather than 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.
-- Using the GraphQL API for GitHub by default to fetch contents quickly at once, so showing and searching entries and media are instant. Saving entries and media is also much faster.
-- Caching Git files locally to speed up startup and reduce bandwidth.
+- Built completely from scratch with Svelte rather than 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.
+- Using the GraphQL API for GitHub by default to quickly fetch contents at once, so that entries and media can be listed and searched instantly. This avoids the slowness and potential API rate limit violations caused by hundreds of requests with relation widgets[^14].
+- Saving entries and media is also much faster thanks to the [GraphQL mutation](https://github.blog/changelog/2021-09-13-a-simpler-api-for-authoring-commits/).
+- Caching Git files locally to further speed up startup and reduce bandwidth.
 - Small footprint: less than 300 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).
 
 ### Better productivity
@@ -58,8 +62,9 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 ### Better i18n support
 
 - Making it easier to switch between locales while editing with just a click on a button.
-- Fields in non-default locales will be validated as expected[^13]
+- Fields in non-default locales will be validated as expected[^13].
 - [Integrating DeepL](#use-deepl-to-translate-entry-fields) to allow translating text fields from another locale with one click.
+- You can [disable non-default locale content](#disable-non-default-locale-content)[^15].
 - You can [use a random UUID for an entry slug](#use-a-random-id-for-an-entry-slug), which is a good option for locales writing in non-Latin characters[^12].
 - Solving limitations in Netlify/Decap CMS’s [list and object widgets](https://decapcms.org/docs/beta-features/#i18n-support) so that changes made with these widgets will be duplicated between locales as expected when using the `i18n: duplicate` field configuration[^7].
 
@@ -73,7 +78,8 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 
 - Required fields, not optional fields, are clearly marked for efficient data entry.
 - Integration with Pexels, Pixabay and Unsplash makes it easy to insert free stock photos into image fields[^8].
-- You can revert changes for all fields or a specific field/object/list.
+- Optional object fields (`widget:object` with `required:false`) can be manually added or removed. If removed, the required subfields will no longer trigger validation errors[^16].
+- You can revert changes to all fields or a specific field.
 
 ### Media library enhancements
 
@@ -198,10 +204,10 @@ You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](
 
 You can use Sveltia CMS with a local Git repository, just like the [beta feature](https://decapcms.org/docs/beta-features/#working-with-a-local-git-repository) in Netlify/Decap CMS, but Sveltia CMS has simplified the workflow by removing the need for additional configuration (the `local_backend` property) and proxy server, thanks to the [File System Access API](https://developer.chrome.com/articles/file-system-access/) available in [some modern browsers](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility).
 
-1. Launch the local development server for your frontend framework, typically with `npm run dev`.
-1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number depends on your framework.
+1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
+1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
 1. Click “Work with Local Repository” and select the project’s root directory once prompted.
-1. Make some changes on Sveltia CMS.
+1. Make some changes to your content on Sveltia CMS.
 1. See if the produced changes look good using `git diff` or a GUI like [GitHub Desktop](https://desktop.github.com/).
 1. Commit and push the changes if satisfied, or discard them if you’re just testing.
 
@@ -252,9 +258,21 @@ Sveltia CMS comes with a handy DeepL integration so that you can translate any t
 1. Sign up for [DeepL API](https://www.deepl.com/pro-api/) and copy your Authentication Key from DeepL’s Account page.
 1. Go back to Sveltia CMS, click on the Account button at the top right corner, then click Settings.
 1. Paste your key to the DeepL API Authentication Key field, and close the Settings dialog.
-1. Open any entry, and you can now translate all fields or individual fields by selecting the Translate menu item.
+1. Open any entry, and you can now translate all fields or individual fields by selecting Translate from the three-dot menu.
 1. If you have upgraded to DeepL API Pro, provide your new Authentication Key in the same way.
 
+### Disable non-default locale content
+
+You can now disable the output of non-default locale content by adding the `save_all_locales` property to the top-level or per-collection `i18n` configuration. Then you’ll find “Disable (locale name)” in the three-dot menu at the top-right corner of the content editor. This is useful if the translation isn’t ready yet, but you want to publish the default locale content first.
+
+```diff
+ i18n:
+   structure: multiple_files
+   locales: [en, fr]
+   default_locale: en
++  save_all_locales: false
+```
+
 ### Use a random ID for an entry slug
 
 By default, the [slug for a new entry file](https://decapcms.org/docs/configuration-options/#slug) will be generated based on the entry’s `title` field. Or, you can specify the collection’s `slug` option to use the file creation date or other fields. While the behaviour is generally acceptable and SEO-friendly, it’s not useful if the title might change later or if it contains non-Latin characters like Chinese. In Sveltia CMS, you can easily generate a random [UUID](https://developer.mozilla.org/en-US/docs/Glossary/UUID) for a slug without a custom widget!
@@ -336,7 +354,7 @@ Want to build a website with Sveltia CMS? [@kyoshino](https://github.com/kyoshin
 
 ## Contributions
 
-Sveltia CMS is still in early beta, so we do expect various problems. Please [report any bugs to us](https://github.com/sveltia/sveltia-cms/issues/new). Feel free to submit feature requests as well. Meanwhile, pull requests may not be accepted for the time being due to limited review resources.
+Sveltia CMS is still in early beta, so we do expect various problems. Please [report any bugs to us](https://github.com/sveltia/sveltia-cms/issues/new). Feel free to submit feature requests as well. Meanwhile, pull requests may not be accepted for the time being due to limited review resources. As we get closer to the 1.0 release, we’ll be welcoming l10n contributors.
 
 ## Related Links
 
@@ -359,3 +377,6 @@ This software is provided “as is” without any express or implied warranty. T
 [^11]: [Netlify/Decap CMS #1382](https://github.com/decaporg/decap-cms/issues/1382) and many more. We’ll be updating this list after reviewing their issue list.
 [^12]: [Netlify/Decap CMS #1975](https://github.com/decaporg/decap-cms/issues/1975)
 [^13]: [Netlify/Decap CMS #5112](https://github.com/decaporg/decap-cms/issues/5112)
+[^14]: [Netlify/Decap CMS #4635](https://github.com/decaporg/decap-cms/issues/4635), [Netlify/Decap CMS #5920](https://github.com/decaporg/decap-cms/issues/5920), [Netlify/Decap CMS #6410](https://github.com/decaporg/decap-cms/issues/6410)
+[^15]: [Netlify/Decap CMS #6932](https://github.com/decaporg/decap-cms/issues/6932)
+[^16]: [Netlify/Decap CMS #2103](https://github.com/decaporg/decap-cms/issues/2103)