Conventions

The convention used for all myst-transforms is to modify the tree in place and export two functions for transforms and plugins.

Plugins¶

The plugins are unifiedjs plugins that can be chained together, for example, unified().use(myPlugin, opts).use(myOtherPlugin).

These plugins are generally very light wrappers around transforms which are the functional analogues of the plugin.

Transforms¶

The transforms are called on a tree, for example, myTransform(tree, opts).

In all cases transformations are completed in place on the AST.

Error Reporting¶

The package uses vfile error reporting messages, this allows you to collect

import { VFile } from 'vfile';

const file = new VFile();

unified()
  .use(mathPlugin, { macros: {} }) // Add the plugin with any options
  .run(tree, file); // Run the AST through the set of plugins

// Check for errors in the messages:
file.messages;

You can also use vfile-reporter to pretty-print the messages for the console.

import { fileWarn } from 'myst-common';

fileWarn(file, 'Replacing \\begin{eqnarray} with \\begin{align*}', {
  node,
  note: 'Although the standard eqnarray environment is available in LaTeX, ...',
  source: 'myst-transforms:math', // colon separated
  url: 'http://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/latex/required/amsmath/amsldoc.pdf',
});