@mdxdb/fs

Store MDXLD documents as files on the file system.

Installation

npm install @mdxdb/fs

Usage

import { createDatabase } from '@mdxdb/fs'
 
const db = createDatabase({
  path: './content',
})

Configuration

interface FsConfig {
  /** Base directory for content */
  path: string
 
  /** File extension (default: '.mdx') */
  extension?: string
 
  /** Watch for file changes */
  watch?: boolean
 
  /** Custom file encoding (default: 'utf-8') */
  encoding?: BufferEncoding
}

File Structure

Documents are stored as MDX files:

content/
├── posts/
│   ├── hello-world.mdx
│   └── second-post.mdx
└── pages/
    ├── about.mdx
    └── contact.mdx

Each file contains frontmatter and content:

---
$type: BlogPost
title: Hello World
author: Jane Doe
---
 
# Hello World
 
Content here...

Examples

Basic Operations

import { createDatabase } from '@mdxdb/fs'
import { parse } from 'mdxld'
 
const db = createDatabase({ path: './content' })
 
// Create
await db.set('posts/hello', parse(`---
title: Hello
---
# Hello
`))
 
// Read
const doc = await db.get('posts/hello')
 
// List
const posts = await db.list('posts/')
 
// Delete
await db.delete('posts/hello')

Watching for Changes

const db = createDatabase({
  path: './content',
  watch: true,
})
 
db.on('change', (event) => {
  console.log(`${event.type}: ${event.path}`)
})
 
db.on('add', (path, doc) => {
  console.log(`Added: ${path}`)
})
 
db.on('remove', (path) => {
  console.log(`Removed: ${path}`)
})

Best Practices

Use meaningful paths - Organize content by type or category
Include metadata - Use frontmatter for all document metadata
Git integration - Commit content changes to version control
Backup regularly - The content directory is your database

@mdxdb/fs

On this page