CNN Markdown Service
npm install cnn-markdown-service
Read these "_requirements_" as "_only tested with_".
- Node.js LTS or higher
``shell`
$ npm install --save --save-exact cnn-markdown-service
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.
You can generate and view the docs locally with the commands below. The open
command will only work on macOS.
`shell`
$ npm run generate-docs
$ open docs/index.html
- 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.
- 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).
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