@sveltia/cms 0.2.1 → 0.2.3

package/README.md

@@ -1,6 +1,6 @@
 # Sveltia CMS
 
-Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator, such as SvelteKit, Next.js and Hugo, to manage the content as static files on a Git repository. The product is now in public beta, with more features to come.
+Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator, such as SvelteKit, Next.js and Hugo, to manage the content as static files on a Git repository. The open source Netlify/Decap CMS alternative is now in public beta, with more features to come.
 
 ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-1.jpg)<br>
 
@@ -16,7 +16,7 @@ Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [N
 
 Sveltia CMS is a Git-based lightweight headless CMS, which means:
 
-- Git-based: Your content is saved as static JSON, YAML or TOML files on your Git repository. No database or API is involved. Your data is yours.
+- Git-based: The content is saved as static JSON, YAML or TOML files on your Git repository. No 3rd party database or API is involved. Your data is yours.
 - Lightweight: The app is compiled as a single small JavaScript file served via a CDN. You don’t have to sign up for a service or install additional software.
 - Headless: The CMS only takes care of raw data. You can read it and render the final content with your favourite framework.
 
@@ -51,7 +51,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 
 - Making it easier to switch between locales while editing.
 - Integrating DeepL to allow translating text fields from another locale with one click. [See below](#use-deepl-to-translate-entry-fields) for details.
-- You can now use a random ID for an entry slug, which is a good option for locales writing in non-Latin characters. [See below](#use-a-random-id-for-an-entry-slug) for details.
+- You can now use a random UUID for an entry slug, which is a good option for locales writing in non-Latin characters[^12]. [See below](#use-a-random-id-for-an-entry-slug) for details.
 - 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[^7].
 - Users can now choose their preferred UI locale.
 
@@ -147,7 +147,7 @@ Here are some starter templates for popular frameworks created by our contributo
 
 ### Migration
 
-If you’re already using Netlify/Decap CMS with the GitHub backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS script tag, and push the change to your repository:
+If you’re already using Netlify/Decap CMS with the GitHub backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS `script` tag, and push the change to your repository:
 
 ```diff
 -<script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
@@ -176,7 +176,7 @@ You can use Sveltia CMS with a local Git repository, just like the [beta feature
 1. Visit `http://localhost:[port]/admin/index.html` with [Chrome, Edge or other Chromium-based browser](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility). The port number depends on your framework.
 1. Click “Work with Local Repository” and select the project’s root directory once prompted.
 1. Make some changes on Sveltia CMS.
-1. See if the produced changes look good using `git diff` or a GUI like GitHub Desktop.
+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.
 
 ### Use a custom icon for a collection
@@ -233,7 +233,7 @@ Sveltia CMS comes with a handy DeepL integration so that you can translate any t
 
 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) without a custom widget!
 
-It’s simple — just specify `{{uuid}}` (full UUID v4) or `{{uuid_short}}` (last 12 characters only) in the `slug` option. The results would look like `4fc0917c-8aea-4ad5-a476-392bdcf3b642` and `392bdcf3b642`, respectively.
+It’s simple — just specify `{{uuid}}` (full UUID v4), `{{uuid_short}}` (last 12 characters only) or `{{uuid_shorter}}` (first 8 characters only) in the `slug` option. The results would look like `4fc0917c-8aea-4ad5-a476-392bdcf3b642`, `392bdcf3b642` and `4fc0917c`, respectively.
 
 ```diff
    - name: members
@@ -292,6 +292,16 @@ If you have image field(s) and expect that images will be inserted as URLs, you
 img-src 'self' blob: data: https://*;
 ```
 
+### Self-host 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 your use cases!
@@ -302,7 +312,7 @@ Feel free to [file an issue](https://github.com/sveltia/sveltia-cms/issues/new)
 
 ## Links
 
-- Introducing Sveltia CMS: a short presentation by [@kyoshino](https://github.com/kyoshino) during the _This Week in Svelte_ online meetup on March 31, 2023 — [recording](https://youtu.be/-YjLubiieYs?t=1660) & [slides](https://docs.google.com/presentation/d/1Wi4ty-1AwOp2-zy7LctmzCV4rrdYPfke9NGhO0DdRdM)
+- Introducing Sveltia CMS: a short technical presentation by [@kyoshino](https://github.com/kyoshino) during the _This Week in Svelte_ online meetup on March 31, 2023 — [recording](https://youtu.be/-YjLubiieYs?t=1660) & [slides](https://docs.google.com/presentation/d/1Wi4ty-1AwOp2-zy7LctmzCV4rrdYPfke9NGhO0DdRdM)
 
 ## Disclaimer
 
@@ -317,3 +327,4 @@ This software is provided “as is” without any express or implied warranty. T
 [^7]: [Netlify/Decap CMS #4386](https://github.com/netlify/netlify-cms/issues/4386)
 [^10]: [Netlify/Decap CMS #341](https://github.com/netlify/netlify-cms/issues/341)
 [^11]: [Netlify/Decap CMS #1382](https://github.com/netlify/netlify-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)