Giter Club home page Giter Club logo

angular-marked's Introduction

angular-marked Bower version

===

AngularJS Markdown using marked.

Please note: neither this directive nor marked (by default) implementation sanitization. As always, sanitizing is necessary for user-generated content.

get this with bower

Usage

  1. bower install angular-marked or bower install Hypercubed/angular-marked
  2. Include the marked.js script into your app. By default should be at bower_components/marked/lib/marked.js.
  3. Include the angular-marked.js into your app. By default should be at bower_components/angular-marked/angular-marked.js.
  4. Add hc.marked as a module dependency to your app.

Set default options (optional)

	app.config(['markedProvider', function(markedProvider) {
	  markedProvider.setOptions({gfm: true});
	}]);

Example using highlight.js Javascript syntax highlighter (must include highlight.js script).

	markedProvider.setOptions({
      gfm: true,
      tables: true,
      highlight: function (code) {
        return hljs.highlightAuto(code).value;
      }
    });

As a directive

	<marked>
	     #Markdown directive
	     *It works!*  
	</marked>

Bind the markdown input to a scope variable:

	<div marked="my_markdown">
	</div>
	<!-- Uses $scope.my_markdown -->

Include a markdown file:

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

As a service

	app.controller('myCtrl', ['marked', function(marked) {
	  $scope.html = marked('#TEST');
	}]);

Testing

Install npm and bower dependencies:

	npm install
	bower install
	npm test

Why?

I wanted to use marked instead of showdown as used in angular-markdown-directive as well as expose the option to globally set defaults. Yes, it is probably best to avoid creating a bunch of angular wrapper modules... but I use this enough across multiple projects to make it worth while for me. Use it if you like. Pull requests are welcome.

Acknowledgments

Based on angular-markdown-directive by briantford which, in turn, is based on this excellent tutorial by @johnlinquist.

License

Copyright (c) 2013 Jayson Harshbarger Gittip donate button Paypal donate button

MIT License

angular-marked's People

Contributors

cesarandreu avatar hypercubed avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.