Skip to content
This repository has been archived by the owner on Nov 26, 2021. It is now read-only.

remark-lint settings enforcing suggestions from the origami component specification

Notifications You must be signed in to change notification settings

Financial-Times/remark-preset-lint-origami-component

Repository files navigation

remark-preset-lint-origami-component

remark preset to configure remark-lint with settings that enforce the rules and suggestions in the origami component specification.

installation

npm install remark-preset-lint-origami-component

use

You can use it by adding it to the plugins in a .remarkrc.js file in the root of your component:

module.exports.plugins = [require("remark-preset-lint-origami-component")]

Or use it directly through the remark cli:

remark -u preset-lint-origami-component README.md

origami build tools

this project is consumed by origami-build-tools and used as part of its verify step.