markdown-magic-prettier

Use prettier to format JS codeblocks in markdown files via markdown-magic

Install

npm install -D markdown-magic markdown-magic-prettier prettier

Note: prettier is a peer dependency and must be installed separately from this module

Adding the plugin

See example.ts for usage.

import path from 'path';
import { markdownMagic } from 'markdown-magic';
import PRETTIER from './index.ts';

const config = {
  matchWord: 'AUTO-GENERATED-CONTENT',
  transforms: {
    PRETTIER,
  },
};

const markdownPath = path.join(import.meta.dirname, 'README.md');
await markdownMagic(markdownPath, config);

Usage in markdown

Wrap code blocks to format the content.

console.log('hello world');

Options

All prettier options are supported.

There are a few defaults set:

const defaults = {
  singleQuote: true,
  trailingComma: 'es5',
};