Skip to content

Commit 7f9f129

Browse files
committed
typo
1 parent 7f088fe commit 7f9f129

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

readme.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
11
# Angular Markdown Editor (Directive)
22
`1.0.0`
33

4-
### What do we have?
4+
## What do we have?
55
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

9-
### How to use it?
10-
##### Creation
9+
## How to use it?
10+
#### Creation
1111
Simply create a `<textarea>` with an `ngModel` and a call to the Directive.
12-
At the end, all you need is: `<textarea markdown-editor="" rows="10" ng-model="markdown"></textarea>`
12+
At the end, all you need is:
13+
```
14+
<textarea markdown-editor="" rows="10" ng-model="markdown"></textarea>
15+
```
1316

14-
##### Extra options
17+
#### Extra options
1518
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.
16-
Like this: `<textarea markdown-editor="{'iconlibrary': 'fa'}"...` or multiple options `<textarea markdown-editor="{'iconlibrary': 'fa', addExtraButtons: true}"...`
19+
Like this: `<textarea markdown-editor="{'iconlibrary': 'fa'}"...` or multiple options
20+
```
21+
<textarea markdown-editor="{'iconlibrary': 'fa', addExtraButtons: true}"...
22+
```
1723

18-
##### Additional extra buttons
24+
#### Additional extra buttons
1925
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.
20-
Like this: `<textarea markdown-editor="{addExtraButtons: true}"...`
26+
Like this:
27+
```
28+
<textarea markdown-editor="{addExtraButtons: true}"...
29+
```
2130

22-
### Dependencies
31+
## Dependencies
2332
* angular.js
2433
* bootstrap _(we also include bootstrap.js)_
2534
* bootstrap-markdown _(editor)_
@@ -29,13 +38,13 @@ Like this: `<textarea markdown-editor="{addExtraButtons: true}"...`
2938
* angular-highlight
3039
* jQuery _(required for Bootstrap-Markdown editor)_
3140

32-
### Demo
41+
## Demo
3342
#### Live demo
3443
[Plunker demo](http://plnkr.co/AFxN7uiwkZlJ9OMZwXey)
3544

3645
#### Code example
3746
You can take a look at the demo under the folder [example](https://github.com/ghiscoding/angular-markdown-editor/example).
3847

39-
**Preview:**
40-
48+
## Preview
49+
Editor &amp; Preview
4150
![Login Page](/images/scrshot_preview.png)

0 commit comments

Comments
 (0)