Skip to content

Commit 3da9651

Browse files
committed
Updated NPM version
1 parent b095a15 commit 3da9651

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-markdown-editor",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"author": "Ghislain B.",
55
"description": "Angular Markdown Editor, all-in-one Markdown Editor and Preview",
66
"main": "app.js",

readme.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,58 @@
11
# Angular Markdown Editor (Directive)
2-
`1.0.0`
2+
`1.0.1`
33

44
## What do we have?
5-
I have put together a few libraries and tools to make a convenient all in one WYSIWYG Markdown Editor and preview. All of that with a simple AngularJS Directive call. I plan to use this mainly for online documentation but it could be useful for many other reasons. Also planning to add a 1-click button for simple copy+paste to email.
5+
I have put together a few libraries and tools to make a convenient "all in one" WYSIWYG Markdown Editor and preview. All of that with a simple AngularJS Directive call. I plan to use this mainly for online documentation but it could be useful for many other reasons. Also planning to add a 1-click button for simple Copy+Paste to email.
66

77
[Marked.js](https://github.com/chjj/marked) is awesome for markdown preview and [Highlight.js](https://highlightjs.org/) is a must for easy code viewing with colors highlighting. The [Bootstrap-Markdown](http://www.codingdrama.com/bootstrap-markdown/) is a really great and simplified WYSIWYG editor which was simply missing integration with AngularJS and so I created a Directive to handle that. For all of these great tools, we will use their AngularJS version for easier integration (for example `Marked.js` and `Angular-Marked`)
88

99
## How to use it?
10-
### Creation
10+
### Installation
11+
##### NPM
12+
```bash
13+
npm install angular-markdown-editor
14+
```
15+
##### NuGet
16+
_Some of the dependencies were added by hand to this package (because they don't all exist on NuGet). For those, you could get latest version and install them yourself as well._
17+
```bash
18+
PM> Install-Package Angular-Markdown-Editor
19+
```
20+
21+
### Inside the HTML
1122
Simply create a `<textarea>` with an `ngModel` and a call to the Directive.
1223
At the end, all you need is:
1324
```
1425
<textarea markdown-editor="" rows="10" ng-model="markdown"></textarea>
1526
```
1627

17-
### Extra options
18-
You can also pass any options from the [Bootstrap-Markdown](http://www.codingdrama.com/bootstrap-markdown/) by passing these options as an object to the directive.
28+
### Extra options (Bootstrap-Markdown)
29+
You can use any of the [Bootstrap-Markdown Options](http://www.codingdrama.com/bootstrap-markdown/) by passing them as an object to the `markdown-editor` directive attribute.
1930
Like this: `<textarea markdown-editor="{'iconlibrary': 'fa'}"...`
2031

2132
or multiple options
2233
```
2334
<textarea markdown-editor="{'iconlibrary': 'fa', addExtraButtons: true}"...
2435
```
2536

26-
### Additional extra buttons
27-
I really thought that some buttons were missing to go a great job (Strikethrough &amp; Table). So I added them to the directive, though they are not enabled by default, you need to enable them manually if you want them or not.
37+
### Editor extra buttons
38+
I really thought that some buttons were missing to go a great job (Strikethrough &amp; Table). So I added them to the directive, they are not enabled by default, so you will need to enable them manually if you do want to use them.
2839
Like this:
2940
```
3041
<textarea markdown-editor="{addExtraButtons: true, 'iconlibrary': 'fa'}"...
3142
```
3243

3344
## Dependencies
34-
* angular.js
35-
* bootstrap _(we also include bootstrap.js)_
36-
* bootstrap-markdown _(editor)_
37-
* marked.js _(markdown preview)_
38-
* angular-marked
39-
* highlight.js _(code syntax highlighting)_
40-
* angular-highlight
41-
* jQuery _(required for Bootstrap-Markdown editor)_
45+
* [angular.js](https://www.angularjs.org/)
46+
* [bootstrap](http://getbootstrap.com/) _(we also include bootstrap.js)_
47+
* [bootstrap-markdown](http://www.codingdrama.com/bootstrap-markdown/) _(editor)_
48+
* [marked.js](https://github.com/chjj/marked) _(markdown preview)_
49+
* [angular-marked](https://github.com/Hypercubed/angular-marked)
50+
* [highlight.js](https://highlightjs.org/) _(code syntax highlighting)_
51+
* [angular-highlight](https://github.com/pc035860/angular-highlightjs)
52+
* [jQuery](http://jquery.com/) _(required for Bootstrap-Markdown editor)_
4253

4354
## Demo
44-
### Live demo
45-
[Plunker demo](http://plnkr.co/AFxN7uiwkZlJ9OMZwXey)
46-
47-
### Code example
48-
You can take a look at the demo under the folder [example](https://github.com/ghiscoding/angular-markdown-editor/example).
55+
[Live Plunker demo](http://plnkr.co/AFxN7uiwkZlJ9OMZwXey) or take a look at the demo under the folder [example](https://github.com/ghiscoding/angular-markdown-editor/example).
4956

5057
## Preview
51-
Editor &amp; Preview
5258
![Login Page](/images/scrshot_preview.png)

0 commit comments

Comments
 (0)