Miss any of our Open RFC calls?Watch the recordings here! »

markdown-magic-prettier

1.0.2 • Public • Published

markdown-magic-prettier

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

Install

yarn add -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.js for usage.

const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');
 
const config = {
  transforms: {
    PRETTIER: require('./index.js'),
  },
};
 
const markdownPath = path.join(__dirname, 'README.md');
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',
};