OLD | NEW |
1 # marked | 1 # marked |
2 | 2 |
3 > A full-featured markdown parser and compiler, written in JavaScript. Built | 3 > A full-featured markdown parser and compiler, written in JavaScript. Built |
4 > for speed. | 4 > for speed. |
5 | 5 |
6 [][badge] | 6 [][badge] |
7 | 7 |
8 ## Install | 8 ## Install |
9 | 9 |
10 ``` bash | 10 ``` bash |
(...skipping 21 matching lines...) Expand all Loading... |
32 breaks: false, | 32 breaks: false, |
33 pedantic: false, | 33 pedantic: false, |
34 sanitize: true, | 34 sanitize: true, |
35 smartLists: true, | 35 smartLists: true, |
36 smartypants: false | 36 smartypants: false |
37 }); | 37 }); |
38 | 38 |
39 console.log(marked('I am using __markdown__.')); | 39 console.log(marked('I am using __markdown__.')); |
40 ``` | 40 ``` |
41 | 41 |
| 42 ### Browser |
| 43 |
| 44 ```html |
| 45 <!doctype html> |
| 46 <html> |
| 47 <head> |
| 48 <meta charset="utf-8"/> |
| 49 <title>Marked in the browser</title> |
| 50 <script src="lib/marked.js"></script> |
| 51 </head> |
| 52 <body> |
| 53 <div id="content"></div> |
| 54 <script> |
| 55 document.getElementById('content').innerHTML = |
| 56 marked('# Marked in browser\n\nRendered by **marked**.'); |
| 57 </script> |
| 58 </body> |
| 59 </html> |
| 60 ``` |
| 61 |
42 ## marked(markdownString [,options] [,callback]) | 62 ## marked(markdownString [,options] [,callback]) |
43 | 63 |
44 ### markdownString | 64 ### markdownString |
45 | 65 |
46 Type: `string` | 66 Type: `string` |
47 | 67 |
48 String of markdown source to be compiled. | 68 String of markdown source to be compiled. |
49 | 69 |
50 ### options | 70 ### options |
51 | 71 |
(...skipping 325 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
377 | 397 |
378 See LICENSE for more info. | 398 See LICENSE for more info. |
379 | 399 |
380 [gfm]: https://help.github.com/articles/github-flavored-markdown | 400 [gfm]: https://help.github.com/articles/github-flavored-markdown |
381 [gfmf]: http://github.github.com/github-flavored-markdown/ | 401 [gfmf]: http://github.github.com/github-flavored-markdown/ |
382 [pygmentize]: https://github.com/rvagg/node-pygmentize-bundled | 402 [pygmentize]: https://github.com/rvagg/node-pygmentize-bundled |
383 [highlight]: https://github.com/isagalaev/highlight.js | 403 [highlight]: https://github.com/isagalaev/highlight.js |
384 [badge]: http://badge.fury.io/js/marked | 404 [badge]: http://badge.fury.io/js/marked |
385 [tables]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-
tables | 405 [tables]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-
tables |
386 [breaks]: https://help.github.com/articles/github-flavored-markdown#newlines | 406 [breaks]: https://help.github.com/articles/github-flavored-markdown#newlines |
OLD | NEW |