eibens-utils / md-ast

md-ast

A markdown parser for Deno that outputs an abstract syntax tree (AST). The underlying markdown engine is a Deno fork of a TypeScript fork of marked.

Demo

The demo.ts file demonstrates basic usage. Run it with Deno and it will output the AST of a simple markdown document as JSON.

Why use md-ast?

If you want to work with a typed markdown AST, but don't care about speed and inline HTML, this module is for you. It is currently based on this Deno fork of a markdown parser, where we override the HTML rendering with a JSON renderer. It is probably quite slow for large documents and does not support HTML. In the long term one should switch to a better, faster, and focused syntax-tree implementation for markdown. For example, unified would be great, but we have to wait for unified Deno support.

Develop

# Run demo:
deno run demo.ts

# Format code and run tests with coverage:
deno fmt && deno test --unstable --coverage=.cov && deno coverage --unstable .cov