@jk2908/mdsrc 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.4.1 - 2026-06-23
+
+- Updated README to reflect the new schema API and removed outdated markdown-it references.
+
 ## 0.4.0 - 2026-06-23
 
 - Breaking: replaced the verbose schema API with a simplified string-based syntax. Fields are now declared as `fieldName: 'type'` instead of `fieldName: { type: 'type' }`, optional fields use a `?` suffix (e.g. `'metadata?'`), and nested objects are declared inline without a `schema` wrapper.

package/README.md

@@ -11,27 +11,19 @@ npm install @jk2908/mdsrc
 ## Usage
 
 ```ts
-import plugin, { type MarkdownItConfig } from '@jk2908/mdsrc'
-import comark from '@comark/markdown-it'
+import plugin from '@jk2908/mdsrc'
 import { defineConfig } from 'vite'
 
-const markdownItConfig: MarkdownItConfig = {
-	linkify: true,
-}
-
 export default defineConfig({
 	plugins: [
 		plugin({
-			markdown: {
-				plugins: [comark],
-				config: markdownItConfig,
-			},
 			collections: [
 				{
 					dir: 'content',
 					name: 'post',
 					schema: {
-						title: { type: 'string' },
+						title: 'string',
+						'date?': 'date',
 					},
 				},
 			],
@@ -40,18 +32,51 @@ export default defineConfig({
 })
 ```
 
-The plugin reads markdown content, validates frontmatter against your schema, and generates typed modules during build and watch. Root config uses `collections`, optional `markdown`, and `logger`. Collection config uses `name`, `dir`, and `schema`.
+The plugin reads markdown content, validates frontmatter against your schema, and generates typed modules during build and watch. Root config uses `collections`, optional `compileOptions`, and `logger`. Collection config uses `name`, `dir`, and `schema`.
+
+### Schema
+
+Fields are declared as `fieldName: 'type'`. Supported types: `string`, `number`, `boolean`, `date`, `object`.
 
-Each entry exports both `html` and `markdown`.
+Optional fields use a `?` suffix: `'metadata?': { author: 'string' }`.
+
+Nested objects are declared inline:
+
+```ts
+schema: {
+	title: 'string',
+	'metadata?': {
+		author: 'string',
+		publishedAt: 'date',
+	},
+}
+```
+
+### Compile Options
+
+Pass `compileOptions` to customise markdown parsing via satteri:
+
+```ts
+plugin({
+	compileOptions: {
+		features: {
+			gfm: true, // tables, footnotes, strikethrough, task lists
+			frontmatter: true, // YAML (---) and TOML (+++)
+			math: false, // LaTeX math blocks
+			smartPunctuation: true, // curly quotes, em-dashes, ellipses
+		},
+		mdastPlugins: [/* transform mdast tree */],
+		hastPlugins: [/* transform hast tree */],
+	},
+	collections: [/* ... */],
+})
+```
 
-- `html` is rendered with `markdown-it-ts`, with hard line breaks preserved by default.
-- Raw HTML is escaped by default because the renderer runs with `html: false`.
-- `markdown` preserves the original body for custom renderers like `@comark/react`.
+See [satteri](https://satteri.bruits.org/) for the full list of compile options and feature toggles.
 
-Use `markdown.plugins` for `markdown-it-ts` compatible plugins, and `markdown.config` to pass renderer options.
-`MarkdownItConfig` is re-exported from `@jk2908/mdsrc`, and `markdown.config` is merged with the default renderer options `{ html: false, breaks: true }`.
+### Output
 
-See `examples/basic` for the default HTML output flow and `examples/components` for the shared `@comark/markdown-it` plugin used with React.
+Each entry exports a `body` field containing the rendered HTML.
 
 If you configure a collection with `name: 'post'`, `mdsrc` exposes `allPosts` from the package root.
 
@@ -61,8 +86,7 @@ import { allPosts } from '@jk2908/mdsrc'
 export const summaries = allPosts.map(post => ({
 	title: post.title,
 	slug: post.__mdsrc.slug,
-	html: post.html,
-	markdown: post.markdown,
+	body: post.body,
 }))
 ```
 
@@ -76,4 +100,4 @@ The generated files live in `./.mdsrc` on disk, so you can import them directly
 
 ## License
 
-MIT
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jk2908/mdsrc",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "type": "module",
   "author": "Jerome Kenway",
   "description": "A Vite plugin for turning structured Markdown content into importable, type-safe modules",