Merge pull request #11 from showdownjs/develop

ng-showdown 1.0.0
showdownjs · Jul 18, 2015 · a4de859 · a4de859
2 parents 0995d83 + a1d25d2
commit a4de859
Show file tree

Hide file tree

Showing 9 changed files with 279 additions and 61 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -71,6 +71,11 @@ module.exports = function (grunt) {
           reporter: 'spec'
         }
       }
+    },
+    karma: {
+      unit: {
+        configFile: 'karma.conf.js'
+      }
     }
   };
 
@@ -82,10 +87,11 @@ module.exports = function (grunt) {
   grunt.loadNpmTasks('grunt-simple-mocha');
   grunt.loadNpmTasks('grunt-jscs');
   grunt.loadNpmTasks('grunt-conventional-changelog');
+  grunt.loadNpmTasks('grunt-karma');
 
   grunt.registerTask('lint', ['jshint', 'jscs']);
-  grunt.registerTask('test', ['lint', 'concat', 'simplemocha']);
-  grunt.registerTask('test-without-building', ['simplemocha']);
+  grunt.registerTask('test', ['lint', 'concat', 'karma']);
+  grunt.registerTask('test-without-building', ['karma']);
   grunt.registerTask('build', ['lint', 'test', 'uglify']);
 
   // Default task(s).

diff --git a/README.md b/README.md
@@ -1,4 +1,70 @@
-ng-showdown
-================
+# ng-showdown
+
+Angular integration for [Showdown](https://github.com/showdownjs/showdown)
+
+## How to use it
+
+1. Install it
+
+  a. via bower:
+  ```
+  bower install --save ng-showdown
+  ```
+  b. via npm
+  ```
+  npm install --save ng-showdown
+  ```
+2. Include `'ng-showdown'` in your module dependencies
+3. Use it
+  ```
+  <p markdown-to-html="vm.mymarkdown"></p>
+  ```
+
+## API
+
+#### `$showdown`
+
+`$showdown.makeHtml(markdown)` - Converts a markdown text into HTML
+
+Input: *string* - markdown to be parsed
+
+Output: *string* - html output from showdown
+
+`$showdown.stripHtml` - Strips a text of it's HTML tags. See http://stackoverflow.com/questions/17289448/angularjs-to-output-plain-text-instead-of-html
+
+Input: *string* - html to be striped
+
+Output: *string* - string without `<html>` tags
+
+#### `markdownToHtml` directive
+
+Example usage:
+```
+ <p markdown-to-html="vm.mymarkdown"></p>
+```
+
+Input: *string* - markdown to be parsed
+
+Output: *string* - html output from showdown
+
+#### `stripHtml` filter
+
+Example usage:
+```
+ <p ng-bind="vm.someText | stripHtml"></p>
+```
+
+Input: *string* - Input to be stripped of html
+
+Output: *string* - stripped html
+
+## Configuration
+
+You can configure the options and extensions passed to showdown by useing the `$showdownProvider`. To see these options, visit the [Showdown page](https://github.com/showdownjs/showdown).
+
+`$showdownProvider.setOption(key, value)` - sets the passed in option as a configuration option in showdown
+
+`$showdownProvider.getOption(key)` - get the option as determined by the passed in key.
+
+`$showdownProvider.loadExtension(extensionName)` - loads the extension into showdown as determined by the passed in extension name
 
-Angular integration for Showdown
diff --git a/bower.json b/bower.json
@@ -13,6 +13,7 @@
     ".*",
     "Gruntfile.js",
     "package.json",
+    "karma.conf.js",
     "src",
     "test"
   ],
@@ -21,13 +22,14 @@
     "url": "https://github.com/showdownjs/ng-showdown.git"
   },
   "dependencies": {
-    "showdown": "1.0.*",
+    "showdown": "1.x",
     "angular": ">=1.3.0 <2.0.0",
     "angular-sanitize": ">=1.3.0 <2.0.0"
   },
   "keywords": [
     "markdown",
     "showdown",
+    "ng-showdown",
     "md",
     "mdown",
     "angular"

diff --git a/dist/ng-showdown.js b/dist/ng-showdown.js
diff --git a/dist/ng-showdown.js.map b/dist/ng-showdown.js.map
diff --git a/karma.conf.js b/karma.conf.js
@@ -0,0 +1,48 @@
+module.exports = function (config) {
+  'use strict';
+  config.set({
+
+    basePath: '',
+
+    frameworks: ['mocha', 'chai'],
+
+    files: [
+      'bower_components/angular/angular.js',
+      'bower_components/angular-mocks/angular-mocks.js',
+      'bower_components/angular-sanitize/angular-sanitize.js',
+      'bower_components/showdown/dist/showdown.js',
+      'src/*.js',
+      'test/**/*.spec.js'
+    ],
+
+    reporters: ['coverage'],
+
+    preprocessors: {
+      'src/**/*.js' : ['progress', 'coverage']
+    },
+
+    //plugins: [
+    //  'karma-chai',
+    //  'karma-coverage',
+    //  'karma-mocha',
+    //  'karma-phantomjs-launcher'
+    //],
+
+    coverageReporter: {
+      type: 'html',
+      dir: 'coverage'
+    },
+
+    port: 9876,
+    colors: true,
+    autoWatch: false,
+    singleRun: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    browsers: ['PhantomJS']
+
+  });
+};
diff --git a/package.json b/package.json
@@ -2,10 +2,9 @@
   "name": "ng-showdown",
   "version": "1.0.0",
   "description": "Official Showdown integration with AngularJS",
-  "author": "Estevão Santos",
-  "contributors": [
-    "Estevão Santos",
-    "Devyn Stott"
+  "authors": [
+    "Estevão Santos (https://github.com/tivie)",
+    "SyntaxRules (https://github.com/SyntaxRules)"
   ],
   "repository": {
     "type": "git",
@@ -19,7 +18,7 @@
   },
   "dependencies": {
     "angular": "^1.3.2",
-    "showdown": "1.0.x",
+    "showdown": "1.x",
     "angular-sanitize": "^1.3.2"
   },
   "devDependencies": {
@@ -30,9 +29,16 @@
     "grunt-contrib-uglify": "^0.6.0",
     "grunt-conventional-changelog": "^1.1.0",
     "grunt-jscs": "^1.2.0",
+    "grunt-karma": "^0.11.2",
     "grunt-simple-mocha": "^0.4.0",
     "jscs": "^1.10.0",
+    "karma": "^0.12.37",
+    "karma-chai": "^0.1.0",
+    "karma-coverage": "^0.4.2",
+    "karma-mocha": "^0.2.0",
+    "karma-phantomjs-launcher": "^0.2.0",
     "mocha": "*",
+    "phantomjs": "^1.9.17",
     "should": "^4.4.2",
     "source-map-support": "^0.2.9"
   }