@knolljo/astro-sveltia-cms 0.1.0 → 0.2.1

package/README.md

@@ -6,6 +6,10 @@ Sveltia CMS integration for Astro.
 
 ```bash
 npm install astro-sveltia-cms @sveltia/cms
+
+bun add astro-sveltia-cms @sveltia/cms
+
+deno add astro-sveltia-cms @sveltia/cms
 ```
 
 ## Usage
@@ -19,7 +23,8 @@ import sveltia from "astro-sveltia-cms";
 export default defineConfig({
   integrations: [
     sveltia({
-      adminRoute: "/cms", // Optional, defaults to "/admin"
+      route: "/cms", // Optional, defaults to "/admin"
+      title: "My CMS", // Optional, defaults to "Sveltia CMS"
       config: {
         load_config_file: false,
         backend: {
@@ -40,12 +45,27 @@ export default defineConfig({
 This will serve the Sveltia CMS admin interface at `/cms` (or `/admin` by default).
 The configuration object is passed directly to `CMS.init()`.
 
-## TypeScript
+## Backend Configuration
 
-You can import `CmsConfig` from `@sveltia/cms` to type your configuration (if supported by your version of Sveltia CMS).
+The `config.backend` property determines where your content is stored. Sveltia CMS supports various Git-based backends and a local development backend.
 
-```ts
-import type { CmsConfig } from "@sveltia/cms";
+### GitHub
+```js
+backend: {
+  name: "github",
+  repo: "username/repo",
+  branch: "main",
+}
+```
 
-const config: CmsConfig = { ... };
+### Gitea / Codeberg
+```js
+backend: {
+  name: "gitea",
+  repo: "username/repo",
+  base_url: "https://codeberg.org",
+  api_root: "https://codeberg.org/api/v1",
+}
 ```
+
+For more details on backend configuration, including authentication and other providers, see the [Sveltia CMS Backend Documentation](https://sveltiacms.app/en/docs/backends).

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 import type { AstroIntegration } from "astro";
-export type CmsConfig = Record<string, any>;
+import type { CmsConfig } from "@sveltia/cms";
+export type { CmsConfig };
 export type SveltiaOptions = {
     /**
      * The route where the CMS will be served.
      * @default "/admin"
      */
-    adminRoute?: string;
+    route?: string;
     /**
      * The page title for the CMS admin interface.
-     * @default "Content Management"
+     * @default "Sveltia CMS"
      */
-    adminTitle?: string;
+    title?: string;
     /**
      * The Sveltia CMS configuration object.
      */

package/dist/index.js

@@ -1,6 +1,6 @@
 export default function sveltiaCms(options) {
-    const adminRoute = options.adminRoute || "/admin";
-    const adminTitle = options.adminTitle || "Content Management";
+    const route = options.route || "/admin";
+    const title = options.title || "Sveltia CMS";
     const virtualModuleId = "virtual:astro-sveltia-cms/config";
     const resolvedVirtualModuleId = "\0" + virtualModuleId;
     return {
@@ -9,7 +9,7 @@ export default function sveltiaCms(options) {
             "astro:config:setup": ({ injectRoute, updateConfig, logger }) => {
                 // Inject the admin page route
                 injectRoute({
-                    pattern: adminRoute,
+                    pattern: route,
                     entrypoint: new URL("./admin.astro", import.meta.url),
                 });
                 // Register the virtual module plugin
@@ -27,7 +27,7 @@ export default function sveltiaCms(options) {
                                     if (id === resolvedVirtualModuleId) {
                                         return `
                       export const config = ${JSON.stringify(options.config)};
-                      export const title = ${JSON.stringify(adminTitle)};
+                      export const title = ${JSON.stringify(title)};
                     `;
                                     }
                                 },
@@ -35,7 +35,7 @@ export default function sveltiaCms(options) {
                         ],
                     },
                 });
-                logger.info(`Sveltia CMS injected at ${adminRoute}`);
+                logger.info(`Sveltia CMS injected at ${route}`);
             },
         },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knolljo/astro-sveltia-cms",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Sveltia CMS integration for Astro",
   "keywords": [
     "astro-integration"
@@ -17,12 +17,13 @@
     "build": "tsc && cp src/admin.astro dist/admin.astro",
     "dev": "tsc --watch"
   },
+  "dependencies": {
+    "@sveltia/cms": "^0.140.4"
+  },
   "peerDependencies": {
-    "@sveltia/cms": "^0.140.4",
     "astro": "^4.0.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@sveltia/cms": "^0.140.4",
     "@types/node": "^20.0.0",
     "astro": "^5.0.0",
     "typescript": "^5.0.0"