remark-preset-stoicism v0.0.2

remark-preset-stoicism

Markdown processor for the Stoicism Compendium.

This is a remark preset defining a number of warnings.

Each of these plugins is configured to emit a warning for the issue mentioned:

These plugins were considered and rejected:

We also use remark-retext with retext-preset-stoicism for text warnings and spellchecking.

Prerequisites

In the following sections, we describe how to install remark-preset-stoicism with npm and how to use it with remark to check and format Markdown files.

Alternatives include yarn instead of npm.

Installation

Install remark-preset-stoicism and other dependencies as a development dependency:

npm install --save-dev \
  remark-preset-stoicism \
  remark-cli

Usage

Configuration

Create a file called .remark.js:

exports.plugins = [require('remark-preset-stoicism')]

Script

Define scripts in your package.json to run remark on your Markdown files:

"scripts": {
  "check-md": "remark --quiet --frail .",
  "format-md": "remark --quiet --frail --output ."
}

Run the scripts with npm run:

npm run check-md
npm run format-md

License

Blue Oak Model License 1.0.0 © Sean Leather