darkmatter-sdk

Darkmatter SDK

Enhance Darkmatter integration with your Astro website.

Install

npm install --save-dev darkmatter-sdk

Usage

Define a multi-line text field

Use text() to define a text field that shows a textarea instead of a single-line input like zod.string() does.

text() returns the same ZodString object as zod.string().

import {z as zod, defineCollection} from 'astro:content';
import {text} from 'darkmatter-sdk';

const posts = defineCollection({
  schema: zod.object({
    title: zod.string(),
    description: text()
  });
});

export const collections = {posts};

Define a date time field

Use dateTime() to define a date field that allows user to set the time, in addition to the date.

dateTime() returns the same ZodDate object as zod.date().

import {z as zod, defineCollection} from 'astro:content';
import {dateTime} from 'darkmatter-sdk';

const posts = defineCollection({
  schema: zod.object({
    title: zod.string(),
    date: dateTime()
  });
});

export const collections = {posts};

Configure a custom entry preview URL

Darkmatter assumes that each entry's URL equals to content collection's name followed by an entry's slug. For example, when editing an entry in "posts" content collection, Darkmatter thinks the entry's URL is /posts/[slug].

However, that may not always be the case. Blog posts could live in a "posts" content collection, but they're actually displayed on a /blog/[slug] page. When you'll try to open an entry in the browser from Darkmatter, you'll see a 404 page.

To work with that use case, you need to tell Darkmatter what is the right URL to open for each entry.

Let's take this example src/content/config.js file.

import {z as zod, defineCollection} from 'astro:content';

const posts = defineCollection({
  schema: zod.object({
    title: zod.string()
  });
});

export const collections = {posts};

To customize the entry preview URL, create a darkmatter.config.js file in the root project folder with this content:

import {defineConfig} from 'darkmatter-sdk';

export default defineConfig({
	collections: {
		posts: {
			basePath: '/blog',
		},
	},
});

Now Darkmatter will open the /blog/[slug] page, instead of /posts/[slug].