|
1 | 1 | # Angular Markdown Editor (Directive)
|
2 |
| -`1.0.4` |
| 2 | +`1.0.5` |
3 | 3 |
|
4 | 4 | ## 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 | +In this package you a few libraries and tools to make a more convenient "all in one" WYSIWYG Markdown Editor with 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 (doc, blog, etc...). Also planning on adding a 1-click button for simple Copy+Paste to email. |
6 | 6 |
|
7 | 7 | [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`)
|
8 | 8 |
|
9 | 9 | ## Demo
|
10 | 10 | [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/tree/master/example).
|
11 | 11 |
|
| 12 | +## Dependencies |
| 13 | +* [angular.js](https://www.angularjs.org/) |
| 14 | +* [bootstrap](http://getbootstrap.com/) _(we also include bootstrap.js)_ |
| 15 | +* [bootstrap-markdown](http://www.codingdrama.com/bootstrap-markdown/) _(editor)_ |
| 16 | +* [marked.js](https://github.com/chjj/marked) _(markdown preview)_ |
| 17 | +* [angular-marked](https://github.com/Hypercubed/angular-marked) |
| 18 | +* [highlight.js](https://highlightjs.org/) _(code syntax highlighting)_ |
| 19 | +* [angular-highlight](https://github.com/pc035860/angular-highlightjs) |
| 20 | +* [jQuery](http://jquery.com/) _(required for Bootstrap-Markdown editor)_ |
| 21 | + |
12 | 22 | ## How to use it?
|
13 | 23 | ### Installation
|
14 | 24 | ##### [NPM](https://www.npmjs.com/package/angular-markdown-editor)
|
15 | 25 | ```bash
|
16 | 26 | npm install angular-markdown-editor
|
17 | 27 | ```
|
18 | 28 | ##### [NuGet](https://www.nuget.org/packages/Angular-Markdown-Editor/)
|
19 |
| -_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._ |
| 29 | +_Some of the dependencies were added manually to this package (because they don't all exist on NuGet). For these packages, you could get them through Github and add them manually yourself or just use the one included with this package._ |
20 | 30 | ```bash
|
21 | 31 | PM> Install-Package Angular-Markdown-Editor
|
22 | 32 | ```
|
23 | 33 |
|
24 | 34 | ### Include Styles & Scripts
|
25 |
| -_NOTE: Unfortunately, the "highlight.js" npm module doesn't seem to have proper bundles, so it's easier for us get the minified CSS and JS files directly from CDN where they are bundled correctly. As for the highlight style, if you want to use another style, then you can replace the "...xxx.min.css" by the name you want to use, for example if we want to use "github", that would be "highlight.js/.../github.min.css"_ |
| 35 | +_NOTE: Unfortunately, the "highlight.js" npm module doesn't seem to have proper bundles, so it's easier for us to get the minified CSS, JS files directly from CDN where they are bundled correctly. As for the highlight styles, if you want to use another style, then you can replace the "...xxx.min.css" by the name you want to use, for example if we want to use "github", we would get "highlight.js/.../github.min.css"_ |
26 | 36 | ```html
|
27 | 37 | <!-- CSS Stylesheet -->
|
28 | 38 | <link rel="stylesheet" href="../node_modules/bootstrap/dist/css/bootstrap.min.css">
|
@@ -70,15 +80,5 @@ I really thought that some buttons were missing to go a great job (~~Strikethrou
|
70 | 80 | <textarea markdown-editor="{addExtraButtons: true, 'iconlibrary': 'fa'}"...
|
71 | 81 | ```
|
72 | 82 |
|
73 |
| -## Dependencies |
74 |
| -* [angular.js](https://www.angularjs.org/) |
75 |
| -* [bootstrap](http://getbootstrap.com/) _(we also include bootstrap.js)_ |
76 |
| -* [bootstrap-markdown](http://www.codingdrama.com/bootstrap-markdown/) _(editor)_ |
77 |
| -* [marked.js](https://github.com/chjj/marked) _(markdown preview)_ |
78 |
| -* [angular-marked](https://github.com/Hypercubed/angular-marked) |
79 |
| -* [highlight.js](https://highlightjs.org/) _(code syntax highlighting)_ |
80 |
| -* [angular-highlight](https://github.com/pc035860/angular-highlightjs) |
81 |
| -* [jQuery](http://jquery.com/) _(required for Bootstrap-Markdown editor)_ |
82 |
| - |
83 | 83 | ## Preview
|
84 | 84 | 
|
0 commit comments