mdat-plugin-example

Mdat rule plugin example template.

Overview

This is an example plugin for the mdat CLI tool, which is a simple Markdown templating system optimized for embedding dynamic content in repository readmes and the like.

Rule plugins are packages that export one or more mdat expansion rules.

This repository just provides a minimal example / project template for creating your own mdat plugins. See mdat-plugin-tldraw and mdat-plugin-cli-help for real-world examples.

If you just need a quick one-off rule specific to your project, you can define it directly in your mdat.config.ts file. A plugin repository is only necessary if you want to share the rule or use it across multiple projects.

A high-level description of the plugin's functionality goes here.

Getting started

Dependencies

We'll assume you have mdat installed either globally or in your local project.

Installation

Install the plugin as a development dependency:

pnpm add -D mdat-plugin-example

Register the plugin in your mdat config file, e.g. mdat.config.ts:

import type { Config } from 'mdat'
import examplePlugin from 'mdat-plugin-example'

export default {
  rules: {
    ...examplePlugin,
  },
} satisfies Config

Usage

A basic demonstration of the plugin's functionality goes here.

Assuming you have a sketch.tldr file in the root of your project, you can embed it in your Markdown file this:

<!-- example -->

Then run the mdat CLI command on your Markdown file to expand the rule:

<!-- example -->

Hello from the [mdat](https://github.com/kitschpatrol/mdat) example plugin!

<!-- /example -->

Maintainers

@kitschpatrol

Contributing

Issues and pull requests are welcome.

License

MIT © Eric Mika