CNN Markdown Service

Requirements

Read these "requirements" as "only tested with".

• Node.js LTS or higher

Install

$ npm install --save --save-exact cnn-markdown-service

Usage

This is intended to be used as a dependency in a larger application. Refer to the example.js that you can run with $ node example/example.js.

ESDoc Documentation

You can generate and view the docs locally with the commands below. The open command will only work on macOS.

$ npm run generate-docs
$ open docs/index.html

NPM scripts

• generate-authors - Generates AUTHORS.md.
• generate-changelog - Generates output to put in CHANGELOG.md.
• generate-coverage - Generates a code coverage report in /coverage.
• generate-docs - Generates ESDoc documentation in /docs.
• test - Runs all tests.
• update-apply - Updates package.json with dependency updates.
• update-check - Outputs if any dependency updates are needed.

Developer notes

• Always develop on the node version specified in the .nvmrc file. If nvm is used typing nvm install in the terminal will insure the correct version is used.

• Contributors should be familiar with the Contributors Guide

• Collaborators should be familiar with the Collaborator Guide

• The current Project Owner (PO) of this project is Jamie Young (@jamsyoung).

Licensing

See LICENSE.md for details.

♥︎ 'Cause I'm A Turn It In And I'm A Turn It Out But Now I've Got To Pass The Mic To Yauch - King Ad-Rock