angular-ivonet-markdown

1.2.0 • Public • Published

angular-ivonet-markdown

A markdown directive for AngularJS (1.x).

Features

See for an demo this plunker or the example in this project.

Install

install:

bower install angular-ivonet-markdown

or

npm install angular-ivonet-markdown

add to your html:

<script src="bower_components/angular-sanitize/angular-sanitize.js"></script>
<script src="bower_components/highlightjs/highlight.pack.js"></script>
<script src="bower_components/angular-highlightjs/build/angular-highlightjs.js"></script>
<script src="bower_components/showdown/src/showdown.js"></script>
<script src="bower_components/angular-ivonet-markdown/dist/markdown.directive.min.js"></script>

if you installed the optional dependencies than don't forget to add them to the html:

<script src="bower_components/showdown-twitter/dist/showdown-twitter.js"></script>
<script src="bower_components/showdown-table/dist/showdown-table.js"></script>
<script src="bower_components/showdown-github/dist/showdown-github.js"></script>
<script src="bower_components/showdown-prettify/dist/showdown-prettify.js"></script>
<script src="bower_components/showdown-target-blank/dist/showdown-target-blank.js"></script>

Start hacking...

Configuration

Please look at the unit tests for examples.

Mandatory Dependencies

bower install highlightjs --save
bower install angular-highlightjs --save
bower install showdown --save
bower install angular-sanitize --save

Optional dependencies

The following dependencies are possible extensions to the standard markdown. Please look at the corresponding project documentation on how to use them.

bower install showdown-github --save
bower install showdown-table --save
bower install showdown-prettify --save
bower install showdown-github --save
bower install showdown-twitter --save
bower install showdown-target-blank --save

I have included some of these in my example.

Notes:

  • the showdown-target-blank is broken at this time but I created a pull request after fixing it in my fork.
  • the showdown-github and showdown-github have not been updated to the latest dependencies and will give deprecated warnings

License

Apache 2.0

Acknowledgements

This directive is based on btford's directive. Thanks for the idea I hope I improved on it.

Package Sidebar

Install

npm i angular-ivonet-markdown

Weekly Downloads

1

Version

1.2.0

License

Apache-2.0

Last publish

Collaborators

  • ivonet