@sveltia/cms 0.5.16 → 0.5.17

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.
Files changed (3) hide show
  1. package/README.md +32 -32
  2. package/dist/sveltia-cms.js +124 -124
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Sveltia CMS
2
2
 
3
- Sveltia CMS is a Git-based lightweight headless CMS under development as a drop-in replacement for [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator like SvelteKit, Eleventy, Next.js and Hugo to manage content as static files in a Git repository. The open source alternative to Netlify/Decap CMS is now in public beta, with more features to come.
3
+ Sveltia CMS is a Git-based lightweight headless CMS under development as a drop-in replacement for [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator like SvelteKit, Eleventy, Next.js and Hugo to manage content as static files in a Git repository. The open source alternative to Netlify/Decap CMS is now in public beta — with more features to come.
4
4
 
5
5
  ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-1.webp)<br>
6
6
 
@@ -10,14 +10,14 @@ Sveltia CMS is a Git-based lightweight headless CMS under development as a drop-
10
10
 
11
11
  ![Screenshot: Stock Photo Integrations; Quick Translation](docs/screenshot-4.webp)<br>
12
12
 
13
- ![Screenshot: Single-Line Migration from Netlify/Decap CMS; Sveltia CMS](docs/screenshot-5.webp)<br>
13
+ ![Screenshot: Single-Line Migration from Netlify/Decap CMS](docs/screenshot-5.webp)<br>
14
14
 
15
15
  ## Features
16
16
 
17
17
  Sveltia CMS is a Git-based lightweight headless CMS, which means:
18
18
 
19
- - 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.
20
- - 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.
19
+ - Git-based: The content is stored as static JSON, YAML or TOML files on your Git repository. No 3rd party database or API is involved. Your data is yours.
20
+ - Lightweight: The app is compiled as a single small JavaScript file served over a CDN. There’s no need to sign up for a service or install additional software.
21
21
  - Headless: The CMS only takes care of raw data. You can read it and render the final content with your favourite framework.
22
22
 
23
23
  Here are some highlights mainly compared to Netlify/Decap CMS:
@@ -43,10 +43,9 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
43
43
  ### Better productivity
44
44
 
45
45
  - Required fields, not optional fields, are clearly marked for efficient data entry.
46
- - Integrating Pexels, Pixabay and Unsplash to allow inserting free stock photos into image fields with no hassle[^8].
46
+ - Integration with Pexels, Pixabay and Unsplash makes it easy to insert free stock photos into image fields[^8].
47
47
  - You can [work on a local Git repository](#work-with-a-local-git-repository) without having to run a proxy server.
48
48
  - Delete multiple entries and assets at once.
49
- - String values in YAML files can be quoted with the new `yaml_quote:true` option for a collection, mainly for framework compatibility[^9].
50
49
  - Solving various outstanding Netlify/Decap CMS bugs[^11].
51
50
 
52
51
  ### Better i18n support
@@ -61,6 +60,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
61
60
 
62
61
  - You can choose a [custom icon for each collection](#use-a-custom-icon-for-a-collection)[^3].
63
62
  - A [per-collection media folder](#use-a-custom-media-folder-for-a-collection) will now appear aside of entries.
63
+ - String values in YAML files can be quoted with the new `yaml_quote: true` option for a collection, mainly for framework compatibility[^9].
64
64
 
65
65
  ### Media library enhancements
66
66
 
@@ -72,57 +72,57 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
72
72
 
73
73
  ## Compatibility
74
74
 
75
- While recreating all the features found in Netlify/Decap CMS is not our goal, we plan to maximize the compatibility before reaching the 1.0 release so that more users can migrate to our modern alternative.
75
+ 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.
76
76
 
77
77
  | Feature | Status in Sveltia CMS |
78
78
  | --- | --- |
79
- | Installation | Installing with npm is not yet supported. |
79
+ | Installation | Installing with npm is not supported yet. |
80
80
  | UI locales | Only English and Japanese are available at this time. No registration is needed. While the UI locale is automatically selected depending on the browser’s language settings, it can be changed in Preferences. (Click on the Account button at the top right corner of the CMS.) |
81
81
  | Account | Only the [GitHub backend](https://decapcms.org/docs/github-backend/) is available at this time. You can keep using Netlify or a [3rd party OAuth client](https://decapcms.org/docs/external-oauth-clients/) (or [our own](https://github.com/sveltia/sveltia-cms-auth)) to sign in with GitHub, just like Netlify/Decap CMS. The GitLab backend is coming soon. We plan to add the Test backend as well for our demo site, but Azure and Bitbucket are unlikely to be supported, mainly due to the lack of an API method to fetch content in bulk. Later we may implement a performant Git Gateway alternative using GraphQL. |
82
82
  | Configuration | Supported. |
83
- | Media | External media storage services are not yet supported. |
84
- | Editorial Workflow | Coming soon. |
83
+ | Media | External media storage services are not supported yet. |
84
+ | Editorial Workflow | Not supported yet. |
85
85
  | Collections | Supported. |
86
86
  | Widgets | [See below](#widget-limitations) for the current limitations. |
87
- | Custom widgets | Not yet supported. |
88
- | Custom previews | Not yet supported. |
87
+ | Custom widgets | Not supported yet. |
88
+ | Custom previews | Not supported yet. |
89
89
 
90
90
  ### Widget limitations
91
91
 
92
92
  | Widget | Status in Sveltia CMS |
93
93
  | --- | --- |
94
- | Code | Not yet supported. |
95
- | Color | It’s a native `<input>` element at this time. The `enableAlpha` option is not yet supported. |
96
- | Date/DateTime | These are also native `<input>` elements. The `date_format` and `time_format` options with Moment.js tokens are not yet supported. We may deprecate the Moment.js format support anyway. |
97
- | File/Image | The `media_library` options are not yet supported other than `max_file_size` and `choose_url`. |
98
- | Map | Not yet supported. |
99
- | Markdown | It’s a plain text editor at this time. We’ll soon implement a rich text editor with i18n issues addressed. |
100
- | Relation | The `search_fields` options is not yet supported. |
94
+ | Code | Not supported yet. |
95
+ | Color | It’s a native `<input>` element at this time. The `enableAlpha` option is not supported yet. |
96
+ | Date/DateTime | These are also native `<input>` elements. The `date_format` and `time_format` options with Moment.js tokens are not supported yet. We may deprecate the Moment.js format support anyway. |
97
+ | 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. |
98
+ | Map | Not supported yet. |
99
+ | Markdown | It’s a plain text editor at this time. A rich text editor is coming soon. |
100
+ | Relation | The `search_fields` options is not supported yet. |
101
101
 
102
102
  ### Beta features in Netlify/Decap CMS
103
103
 
104
104
  | Feature | Status in Sveltia CMS |
105
105
  | --- | --- |
106
106
  | Working with a Local Git Repository | Supported. [See below](#work-with-a-local-git-repository) for details. |
107
- | GitLab and BitBucket Editorial Workflow Support | The GitLab backend is not yet supported. No plan to support BitBucket. |
107
+ | GitLab and BitBucket Editorial Workflow Support | The GitLab backend is not supported yet. No plan to support BitBucket. |
108
108
  | i18n Support | Supported. In fact, i18n is at the core of Sveltia CMS! |
109
109
  | GitHub GraphQL API | Supported. Sveltia CMS uses GraphQL by default for a better performance. It cannot be disabled. |
110
- | GitLab GraphQL API | The GitLab backend is not yet supported. |
111
- | Open Authoring | Not yet supported. |
110
+ | GitLab GraphQL API | The GitLab backend is not supported yet. |
111
+ | Open Authoring | Not supported yet. |
112
112
  | Folder Collections Path | Supported. |
113
113
  | Folder Collections Media and Public Folder | Supported. We recommend using [absolute path per-collection folders](#use-a-custom-media-folder-for-a-collection) for easier asset management rather than relative path per-entry folders. |
114
114
  | List Widget: Variable Types | Supported. |
115
115
  | Custom Mount Element | Supported. |
116
- | Manual Initialization | Not yet supported. |
117
- | Raw CSS in registerPreviewStyle | Not yet supported. |
118
- | Squash merge GitHub pull requests | Editorial workflow is not yet supported. |
116
+ | Manual Initialization | Not supported yet. |
117
+ | Raw CSS in registerPreviewStyle | Not supported yet. |
118
+ | Squash merge GitHub pull requests | Editorial workflow is not supported yet. |
119
119
  | Commit Message Templates | Supported. |
120
120
  | Image widget file size limit | Supported. |
121
121
  | Summary string template transformations | Supported. |
122
- | Registering to CMS Events | Not yet supported. |
122
+ | Registering to CMS Events | Not supported yet. |
123
123
  | Dynamic Default Values | Supported. |
124
- | Nested Collections | Not yet supported. |
125
- | Remark plugins | Not yet supported. |
124
+ | Nested Collections | Not supported yet. |
125
+ | Remark plugins | Not supported yet. |
126
126
 
127
127
  ### Other features
128
128
 
@@ -172,7 +172,7 @@ If you’re already using Netlify/Decap CMS with the GitHub backend and don’t
172
172
 
173
173
  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 on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
174
174
 
175
- That said, we highly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#work-with-a-local-git-repository) for how.
175
+ That said, we strongly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#work-with-a-local-git-repository) for how.
176
176
 
177
177
  ## Tips & tricks
178
178
 
@@ -182,7 +182,7 @@ You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](
182
182
 
183
183
  ### Work with a local Git repository
184
184
 
185
- 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 necessity of the 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).
185
+ 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).
186
186
 
187
187
  1. Launch the local development server for your frontend framework, typically with `npm run dev`.
188
188
  1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number depends on your framework.
@@ -312,7 +312,7 @@ Sveltia CMS is open source for sure! You can host it on your server rather than
312
312
  1. Run `pnpm install && pnpm build` at the project root.
313
313
  1. `sveltia-cms.js` will be generated under the `dist` directory.
314
314
 
315
- Importing the CMS as an npm package is not yet supported.
315
+ Importing the CMS as an npm package is not supported yet.
316
316
 
317
317
  ## Support & feedback
318
318
 
@@ -324,7 +324,7 @@ Want to build a website with Sveltia CMS? [@kyoshino](https://github.com/kyoshin
324
324
 
325
325
  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.
326
326
 
327
- ## Links
327
+ ## Related Links
328
328
 
329
329
  - 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)
330
330