remark-preset-survivejs

🎉 Book markdown and prose style.

Installation

npm:

npm install remark-cli remark-preset-survivejs --save

Now add the following to your package.json:

  "scripts": {
    "build-md": "remark ."
    "test": "npm run build-md && ..."
  },
  "remarkConfig": {
    "plugins": ["preset-survivejs"]
  },

From now on, npm test also checks markdown.

npm test

Checks

Markdown

• Extends remark-preset-lint-recommended, and adds a strict code-style (see index.js);
• Checks broken local links;
• Markdown is compiled with asterisk list-item bullets (*), and fenced code blocks (note: set output: true in your config to benefit from this);
• How remark compiles can be configured inline with comments;
• Table of Contents headers are kept up to date, with a depth of 3 (if output: true);
• GH references, like mentions or issue references, are linked (if output: true).

Natural Language

• One [space][] between sentences;
• Checks “indefinite articles”: “a” or “an”;
• Checks accidental repeated words;
• Checks incorrectly placed apostrophes in contractions.

License

MIT © Titus Wormer