Skip to content

v1.2.0 - AST Libraries

Latest

Choose a tag to compare

@github-actions github-actions released this 08 Feb 06:54

New Features

AST Companion Libraries

Four new libraries for structured markdown output:

  • quikdown_ast - Markdown to AST (Abstract Syntax Tree) parser
  • quikdown_json - Markdown to JSON conversion
  • quikdown_yaml - Markdown to YAML conversion (zero dependencies)
  • quikdown_ast_html - AST/JSON/YAML to HTML renderer

Usage

import quikdown_ast from 'quikdown/ast';
import quikdown_json from 'quikdown/json';
import quikdown_yaml from 'quikdown/yaml';
import quikdown_ast_html from 'quikdown/ast-html';

const markdown = '# Hello **world**';

const ast = quikdown_ast(markdown);
const json = quikdown_json(markdown);
const yaml = quikdown_yaml(markdown);
const html = quikdown_ast_html(ast);

Highlights

  • Forgiving parser - handles malformed markdown gracefully
  • Loop protection - built-in safeguards against infinite loops
  • Zero dependencies - YAML serializer included
  • Full test coverage - 95%+ line coverage, 1112 tests
  • TypeScript support included

Documentation

Bundle Sizes

Library Minified
quikdown.js 9.0 KB
quikdown_bd.js 13.8 KB
quikdown_edit.js 68.0 KB
quikdown_ast.js ~5 KB
quikdown_json.js ~5 KB
quikdown_yaml.js ~7 KB
quikdown_ast_html.js ~10 KB