https://github.com/yaru22/angular-md

Angular directive to render Markdown text. It's built on blazingly fast markdown parser 'marked'.
https://github.com/yaru22/angular-md

Last synced: 17 days ago
JSON representation

Angular directive to render Markdown text. It's built on blazingly fast markdown parser 'marked'.

• Host: GitHub
• URL: https://github.com/yaru22/angular-md
• Owner: yaru22
• License: mit
• Created: 2014-01-14T16:58:24.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-01-22T17:53:57.000Z (almost 8 years ago)
• Last Synced: 2024-10-18T17:08:00.663Z (26 days ago)
• Language: JavaScript
• Homepage:
• Size: 255 KB
• Stars: 24
• Watchers: 2
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - angular-md - Angular directive to render Markdown text. It's built on blazingly fast markdown parser 'marked'. (JavaScript)

README

        
# angular-md [![Analytics](https://ga-beacon.appspot.com/UA-2694988-7/angular-md/readme?pixel)](https://github.com/yaru22/angular-md)

Angular directive to render [Markdown](http://daringfireball.net/projects/markdown/) text. It's built on blazingly fast markdown parser [marked][].

## Demo

Check out the demo [here](http://www.brianpark.ca/projects/angular_md/demo/).

## Usage

Include `angular-md.js` in your project (you can do so via `bower install angular-md`).

Make sure to load [marked][] library. Optionally, load [highlightjs][] library (as well as the corresponding css file) for code highlighting.

Load the directive after loading `angular.js`

```html

```

Specify angular-md as a dependency of your Angular module.

```js

var app = angular.module('ngApp', [

  'yaru22.md'

]);

```

Use it in your project.

```html

...

  

# How to use angular-md

This is a example of how to use angular-md.

- Bullet point 1.

- Bullet point 2.

> To use or not to use...

> - Anonymous

  

  

  

  

  

  

  

  

```

## License

This seed is released under permissive MIT License.

[highlightjs]: https://github.com/isagalaev/highlight.js  "highlightjs"

[marked]: https://github.com/chjj/marked  "marked"