config-remark

config-remark is a configuration preset for remark-cli used by the fundamend.dev ecosystem.

Installation

Use your favorite Node.js package manager, for example npm, like so:

npm install --save-dev @fundamend/config-remark

... or yarn, like so:

yarn add --dev @fundamend/config-remark

Usage

In your .remarkrc.js, import config-remark and add it to the plugins array, like so:

const config = require('@fundamend/config-remark');

const plugins = [fundamend];
const settings = {};

module.exports = {
	plugins: plugins,
	settings: settings
};

You can extend the imported preset by adding additional plugins to the plugin array or configuration options to the exported settings object, for example like this:

const config = require('@fundamend/config-remark');
const autolinkHeadings = require('remark-autolink-headings');

const plugins = [fundamend, autolinkHeadings];
const settings = {};

module.exports = {
	plugins: plugins,
	settings: settings
};

Settings that already exist in the configuration preset will be overwritten.

License

MIT