knockout-commonmark

Knockout.CommonMark

Knockout.CommonMark provides Knockout bindings for CommonMark allowing markdown stored in the view model to be displayed as HTML.

Dependencies

• Knockout (3.3.0)
• CommonMark (0.22.0)

Installing

You are always able to download the latest stable release from the releases page on GitHub otherwise you can install via one of the following methods.

Bower

bower install knockout-commonmark

NPM

npm install knockout-commonmark

Usage

Knockout.CommonMark exposes itself as an AMD compliant module, if it can't do that it will add itself to the global scope. Once you have loaded Knockout.CommonMark then you can bind your view model like so:

<div data-bind="commonmark: text"></div>

For a basic example on how to use this please have a look at the demos.

Issues

If you find any issues while using Knockout.CommonMark please feel free to report them at the GitHub Repository.

Contributing

Knockout.Commonmark is built using gulp by default running gulp will minimise the file, gulp watch is setup to minimise the file whenever the source file is changed. gulp dist will create a distribution archive containing only the following:

• knockout.commonmark.js
• README.md
• LICENSE

License

Knockout.CommonMark is available under the MIT license which is as follows:

Copyright © 2014 Michael Lowen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 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.