Loopstack Markdown Parser

A TypeScript/ESM module for parsing Markdown files according to a JSON schema structure. This parser maps structured Markdown content to JavaScript objects based on provided JSON schema definitions.

Features

• Parse Markdown content into structured objects
• Validate extracted data against JSON schemas
• Support for nested object structures
• Handle arrays and lists in Markdown

Installation

1npm install @loopstack/markdown-parser

Usage

TypeScript

1import { MarkdownParser, SimpleJSONSchema } from '@loopstack/markdown-parser';
2
3// Create a parser instance
4const parser = new MarkdownParser();
5
6// Define a schema for your markdown structure
7const schema: SimpleJSONSchema = {
8  type: 'object',
9  properties: {
10    Title: { type: 'string' },
11    Description: { type: 'string' },
12    Features: {
13      type: 'array',
14      items: {
15        type: 'object',
16        properties: {
17          Name: { type: 'string' },
18          Details: { type: 'string' }
19        }
20      }
21    }
22  },
23  required: ['Title']
24};
25
26// Markdown content to parse
27const markdown = `# Title
28This is a product description.
29
30# Description
31More detailed information about the product.
32
33# Features
34
35## Feature 1
36
37### Name
38Feature 1
39
40### Details
41This is an amazing feature.
42
43## Feature 2
44
45### Name
46Feature 2
47
48### Details
49Another great feature.
50`;
51
52// Parse the markdown content
53async function parseMarkdown() {
54  const result = await parser.parse(markdown, schema);
55  console.log(result);
56}
57
58parseMarkdown();
59/* Output:
60{
61  Title: 'This is a product description.',
62  Description: 'More detailed information about the product.',
63  Features: [
64    {
65      Name: 'Feature 1',
66      Details: 'This is an amazing feature.'
67    },
68    {
69      Name: 'Feature 2',
70      Details: 'Another great feature.'
71    }
72  ]
73}
74*/

JavaScript

1import { MarkdownParser } from '@loopstack/markdown-parser';
2
3// Create a parser instance
4const parser = new MarkdownParser();
5
6// Define a schema for your markdown structure
7const schema = {
8  type: 'object',
9  properties: {
10    Title: { type: 'string' },
11    Description: { type: 'string' }
12  },
13  required: ['Title']
14};
15
16// Parse the markdown content
17const result = await parser.parse(markdown, schema);

API

MarkdownParser Class

parse(markdownContent, schema)

Parses markdown content according to a JSON schema and validates it against the schema.

• markdownContent (String): The markdown text to parse
• schema (SimpleJSONSchema): A JSON schema definition that describes the structure of the markdown content

Returns: A Promise that resolves to the parsed object structure.

validate(object, schema)

Validates an object against a JSON schema.

• object (any): The object to validate
• schema (SimpleJSONSchema): The JSON schema to validate against

Throws an error if validation fails.

Development

Building

1npm run build

Testing

1npm test

Author

Jakob Klippel
LinkedIn: Jakob Klippel

License

MIT