Skip to content
AngularJS markdown directive using Showdown.js
JavaScript
Branch: master
Clone or download
btford Merge pull request #54 from tobiaspatton-s4/master
Fix example in README.md file
Latest commit 4e99c3c Aug 31, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml
README.md
bower.json
karma.conf.js
markdown.js
markdown.spec.js test: using extensions Apr 21, 2014
package.json

README.md

angular-markdown-directive Build Status

Bower Component for a simple AngularJS Markdown directive using Showdown. Based on this excellent tutorial by @johnlinquist.

Usage

  1. bower install angular-markdown-directive
  2. Include angular-sanitize.js. It should be located at bower_components/angular-sanitize/.
  3. Include showdown.js. It should be located at bower_components/showdown/.
  4. Include markdown.js provided by this component into your app.
  5. Add btford.markdown as a module dependency to your app.
  6. Insert the btf-markdown directive into your template:
<btf-markdown>#Markdown directive *It works!*</btf-markdown>

You can also bind the markdown input to a scope variable:

<div btf-markdown="markdown">
</div>
<!-- Uses $scope.markdown -->

Or include a markdown file:

<div btf-markdown ng-include="'README.md'">
</div>
<!-- Uses content from README.md -->

Options

You can configure the markdownConverterProvider:

angular.module('myApp', [
  'ngSanitize',
  'btford.markdown'
]).
config(['markdownConverterProvider', function (markdownConverterProvider) {
  // options to be passed to Showdown
  // see: https://github.com/coreyti/showdown#extensions
  markdownConverterProvider.config({
    extensions: ['twitter']
  });
}])

License

MIT

You can’t perform that action at this time.