Markdown Query Language

NodeJS Module for indexing and querying a set of Markdown documents.

Quickstart

<!-- contents of doc.md -->

# Example markdown file

Project tasks for project #my-project:

- [ ] some task
- [x] another task
  - [ ] a subtask that is tagged #my-tag
Copy

//Create an index instance. Also supports glob patterns to index directories.
const repository = new DocumentRepository("doc.md");
//Update the index
repository.index();
//query the index
const query = Query.parse(
  "TASKLIST text FROM tasks WHERE status='open' AND tags=~'my-tag'"
);
const queryExecutor = new QueryExecutor(repository);
const openTasks = queryExecutor.execute(Query.parse()).toMarkdown();
console.log(openTasks);
/*
Output:
- [ ] a subtask that is tagged #my-tag
 */
Copy

openTasks now contains all open tasks located somewhere in your markdown files.

Query language

The query language is similar to SQL, but not compatible. The query structure is [viewtype] [field1, field2, ...] FROM [dataset] WHERE [condition]

Examples:

• LIST status, text FROM tasks - Lists the status and the text of all markdown tasks as bullet points
• TASKLIST text FROM tasks - Creates a set

This module automatically indexes a given set of markdown files Currently we index the following facts:

• Headings (e.g. ## This is a heading)
• Tasks (e.g. - [ ] an open task)
• Tags (e.g. #some-hashtag)