@directdb/markdown-handler

Markdown file handler with YAML front matter for DirectDB.


Keywords
database, embedded, flat, markdown, yaml, front-matter, frontmatter, front, matter, directdb, nodejs, javascript, json, typescript, embedded-database
License
ISC
Install
npm install @directdb/markdown-handler@0.5.0

Documentation

🗂️ DirectDB

NPM GitHub Workflow Status Node.js Versions

Turn a folder into a database. Store data in human-readable files like Markdown, JSON, and YAML.

Still in development. Expect breaking changes.

Packages

  • directdb

    The main package. Start here!

  • @directdb/core

    Core of the database. Out of the box, it handles all files as plain text. Use this if you want to make your own variant of DirectDB.

  • ajv-orm

    Uses AJV custom keywords to define an ORM, using JSON Schemas as Model definitions. Make "dumb" JSON objects smart, with foreign key relationships, getters, methods, and more.

  • light-matter

    Unopinionated tool for creating custom front matter handlers. Created because other front matter tools baked in YAML or Markdown handlers we do not want.

File Handlers

Docs

About

Created by pskfyi for personal projects and rapid prototyping. ISC licensed.

Thanks to lowdb for much inspiration and for showing how to unit test file system operations.

Information about design philosophy and technologies used can be found in the docs.