diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8af1a52 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = space +charset = utf-8 +end_of_line = lf +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..12c0d06 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +# Commenting this out is preferred by some people, see +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- +node_modules + +# Users Environment Variables +.lock-wscript diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..b6c760e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,16 @@ +language: node_js +sudo: false + +node_js: + - "0.10" + - "0.12" + - "iojs" + +after_success: + - npm run coverage + - npm i coveralls + - cat ./coverage/lcov.info | coveralls + +notifications: + email: + on_success: never diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a7cf1c5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Change Log +All notable changes to this project will be documented in this file. +This project adheres to [Semantic Versioning](http://semver.org/). + +## 0.0.0 - 2015-xx-xx +- Initial commits diff --git a/LICENSE b/LICENSE index 1bd168d..9e265e1 100644 --- a/LICENSE +++ b/LICENSE @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.md b/README.md index ae2e76a..dfee413 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# jstransformer-megamark -megamark support for JSTransformers. +# jstransformer-megamark [![The MIT License][license-img]][license-url] + + + +[megamark](https://github.com/bevacqua/megamark) support for [JSTransformers][jstransformers-url]. + +[![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] [![npmjs.com][npmjs-img]][npmjs-url] + + +## Install +``` +npm install jstransformer-megamark --save +npm test +``` + + +## Usage +> For more use-cases see the **tests** in [test folder](./test) or see the [JSTransformer API](http://github.com/jstransformers/jstransformer#api) for more details. + +```js +var megamark = require('jstransformer')(require('jstransformer-megamark')); + +console.log(megamark.render('_Hello_, **world**!').body); +//=> '

Hello, world!

' +``` + + +## Contributing +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jstransformers/jstransformer-megamark/issues/new). + + +## License +[The MIT License][license-url] + + +[npmjs-url]: https://www.npmjs.com/package/jstransformer-megamark +[npmjs-img]: https://img.shields.io/npm/v/jstransformer-megamark.svg + +[license-url]: ./LICENSE +[license-img]: https://img.shields.io/badge/license-MIT-blue.svg + +[travis-url]: https://travis-ci.org/jstransformers/jstransformer-megamark +[travis-img]: https://img.shields.io/travis/jstransformers/jstransformer-megamark.svg + +[coveralls-url]: https://coveralls.io/r/jstransformers/jstransformer-megamark +[coveralls-img]: https://img.shields.io/coveralls/jstransformers/jstransformer-megamark.svg + +[david-url]: https://david-dm.org/jstransformers/jstransformer-megamark +[david-img]: https://img.shields.io/david/jstransformers/jstransformer-megamark.svg + +[jstransformers-url]: http://github.com/jstransformers diff --git a/index.js b/index.js new file mode 100644 index 0000000..b411ad8 --- /dev/null +++ b/index.js @@ -0,0 +1,11 @@ +'use strict'; + +var megamark = require('megamark'); + +exports.name = 'megamark'; +exports.inputFormats = ['md', 'markdown', 'megamark']; +exports.outputFormat = 'html'; + +exports.render = function (str, options) { + return megamark(str, options); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..6622cb1 --- /dev/null +++ b/package.json @@ -0,0 +1,24 @@ +{ + "name": "jstransformer-megamark", + "version": "0.0.0", + "description": "megamark support for JSTransformers.", + "keywords": [ + "jstransformer" + ], + "files": [ + "index.js" + ], + "devDependencies": { + "test-jstransformer": "^1.0.0" + }, + "scripts": { + "coverage": "test-jstransformer coverage", + "test": "test-jstransformer" + }, + "repository": "jstransformers/jstransformer-megamark", + "author": "JSTransformers Team (https://github.com/orgs/jstransformers/people)", + "license": "MIT", + "dependencies": { + "megamark": "^3.1.0" + } +} diff --git a/test/dependencies.json b/test/dependencies.json new file mode 100644 index 0000000..fe51488 --- /dev/null +++ b/test/dependencies.json @@ -0,0 +1 @@ +[] diff --git a/test/expected.html b/test/expected.html new file mode 100644 index 0000000..52ed1ab --- /dev/null +++ b/test/expected.html @@ -0,0 +1 @@ +

Hello, world!

diff --git a/test/input.md b/test/input.md new file mode 100644 index 0000000..0d5f665 --- /dev/null +++ b/test/input.md @@ -0,0 +1 @@ +_Hello_, **world**! diff --git a/test/locals.json b/test/locals.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/test/locals.json @@ -0,0 +1 @@ +{} diff --git a/test/options.json b/test/options.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/test/options.json @@ -0,0 +1 @@ +{}