remark-directive-to-custom-tag

A remark extension to automatically parse markdown directives into specified tags while preserving all the provided attributes

Install

Important

You need to have install the remark-directive extension

npm install @matfire/remark-directive-to-custom-tag

Usage

import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkDirective from 'remark-directive'
import remarkDirectiveToCustomTag from "@matfire/remark-directive-to-custom-tag"

const html = await unified()
    .use(remarkParse)
    .use(remarkDirective)
    .use(remarkDirectiveToCustomTag, {/* config goes here */})
    .process('...')

Configuration Options

The configuration options are structured as such:

{
    log: boolean //whether or not to allow log output (useful for debugging): defaults to false,
    associations: [
        {
            type: string; // can be either "containerDirective", "leafDirective" or "textDirective"; check the remark-directive documentation to learn more
            directiveName: string; // the name of the directive you want to select. To target a directive written like ::youtube, you would write here 'youtube'
            tagName: string; // the name of the output node tag (here I personally use webcomponents, but you do you),
            validator?: StandardSchema // optional validator. Accepts any library implementing the StandardSchema specification (includind zod, arktype and more) 
        }
    ]
}

Using Validators

Since version 0.1.0, you can provide a validator object/function. This validator uses the StandardSchema and thus supports all validation libraries implementing said interface (including zod, arktype, valibot etc).

Here's an example (taken from the tests for this package) that uses arktype to define a validator:

import { type } from "arktype"

//the rest of your unified process would go here
.use(remarkDirectiveToCustomTag, {
    associations: [
        {
            type: 'leafDirective',
            directiveName: 'test',
            tagName: 'test',
            validator: type({ // the import bit is here
                name: 'string',
                surname: 'string'
            })
        }
    ]
})