Structured Data
mdxdb
Create, Manage, & Publish MDX & URL-centric File System & Database
mdxdb
mdxdb provides a unified interface for storing and querying MDXLD documents across multiple storage backends.
Installation
Features
- Unified API - Same interface across all storage backends
- URL-centric - Documents are addressed by URLs/paths
- Full-text Search - Search across document content
- Type-safe - Full TypeScript support
- Pluggable - Easy to add custom adapters
Storage Adapters
| Package | Backend | Use Case |
|---|---|---|
| @mdxdb/fs | File System | Local development, static sites |
| @mdxdb/sqlite | SQLite | Embedded database, edge computing |
| @mdxdb/clickhouse | ClickHouse | Analytics, time-series |
| @mdxdb/api | HTTP API | Remote mdxdb server |
Quick Start
File System Adapter
SQLite Adapter
Core API
Database Interface
Get Options
Set Options
List Options
Search Options
Working with Documents
Creating Documents
Querying Documents
Updating Documents
Deleting Documents
API Client
Connect to a remote mdxdb server:
Fumadocs Integration
Use mdxdb as a content source for Fumadocs:
See @mdxdb/fumadocs for more details.
Next Steps
- Getting Started - Detailed setup guide
- Adapters - Choose a storage backend
- Fumadocs Integration - Use with Fumadocs