adf-widget-markdown

Markdown widget for the angular-dashboard-framework.

Build

The widget is build with the help of node, npm, bower and gulp. For a install instruction for node and npm, please have a look here.

#### Installing bower and gulp

``bash
npm install -g bower
npm install -g gulp
`

#### Installing dependencies

`bash
npm install
bower install
`

#### Build the adf-widget-markdown

`bash
gulp
`

The compiled and optimized files can be found in the dist directory.

#### Other build goals

Each goal can be used as parameter for the gulp command.

clean*: removes the dist folder
lint*: checks css and javascript files for common errors
serve*: starts an webserver to test the widget

Usage

Install the widget with bower:

`bash
bower install adf-widget-markdown --save
`

Include the script in your index.html and be sure it is loaded after angular and after the angular-dashboard-framework.

`html



`

Define a dependency for the module:

`javascript
angular.module('sample', ['adf', 'adf.widget.markdown']);
``