markdowndb

MarkdownDB

MarkdownDB is a javascript library that turns markdown files into structured queryable databaase (SQL-based and simple JSON). It helps you build rich markdown-powered sites easily and reliably. Specifically it:

• Parses your markdown files to extract structured data (frontmatter, tags etc) and builds a queryable index either in JSON files or a local database (SQLite, MySQL, or PostgreSQL)
• Provides a lightweight javascript API for querying the index and using the data files into your application

Database Support

MarkdownDB supports multiple database backends through Knex.js:

• SQLite (default) - Perfect for local development and small to medium sites. No additional setup required.
• MySQL - Great for larger sites and when you need a separate database server. Requires mysql2 package.
• PostgreSQL - Enterprise-grade database with advanced features. Requires pg package.

All databases provide the same API and features, so you can easily switch between them based on your needs.

Features and Roadmap

• Index a folder of files - create a db index given a folder of markdown and other files
  • Command line tool for indexing: Create a markdowndb (index) on the command line v0.1
  • SQL(ite) index v0.2
  • MySQL and PostgreSQL support - Use MySQL or PostgreSQL as your database backend
  • JSON index v0.6
  • BONUS Index multiple folders (with support for configuring e.g. prefixing in some way e.g. i have all my blog files in this separate folder over here)
  • Configuration for Including/Excluding Files in the folder