Blame view

bower_components/marked/README.md 9.54 KB
73bcce88   luigser   COMPONENTS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
  # marked
  
  > A full-featured markdown parser and compiler, written in JavaScript. Built
  > for speed.
  
  [![NPM version](https://badge.fury.io/js/marked.png)][badge]
  
  ## Install
  
  ``` bash
  npm install marked --save
  ```
  
  ## Usage
  
  Minimal usage:
  
  ```js
  var marked = require('marked');
  console.log(marked('I am using __markdown__.'));
  // Outputs: <p>I am using <strong>markdown</strong>.</p>
  ```
  
  Example setting options with default values:
  
  ```js
  var marked = require('marked');
  marked.setOptions({
    renderer: new marked.Renderer(),
    gfm: true,
    tables: true,
    breaks: false,
    pedantic: false,
    sanitize: true,
    smartLists: true,
    smartypants: false
  });
  
  console.log(marked('I am using __markdown__.'));
  ```
  
  ### Browser
  
  ```html
  <!doctype html>
  <html>
  <head>
    <meta charset="utf-8"/>
    <title>Marked in the browser</title>
    <script src="lib/marked.js"></script>
  </head>
  <body>
    <div id="content"></div>
    <script>
      document.getElementById('content').innerHTML =
        marked('# Marked in browser\n\nRendered by **marked**.');
    </script>
  </body>
  </html>
  ```
  
  ## marked(markdownString [,options] [,callback])
  
  ### markdownString
  
  Type: `string`
  
  String of markdown source to be compiled.
  
  ### options
  
  Type: `object`
  
  Hash of options. Can also be set using the `marked.setOptions` method as seen
  above.
  
  ### callback
  
  Type: `function`
  
  Function called when the `markdownString` has been fully parsed when using
  async highlighting. If the `options` argument is omitted, this can be used as
  the second argument.
  
  ## Options
  
  ### highlight
  
  Type: `function`
  
  A function to highlight code blocks. The first example below uses async highlighting with
  [node-pygmentize-bundled][pygmentize], and the second is a synchronous example using
  [highlight.js][highlight]:
  
  ```js
  var marked = require('marked');
  
  var markdownString = '```js\n console.log("hello"); \n```';
  
  // Async highlighting with pygmentize-bundled
  marked.setOptions({
    highlight: function (code, lang, callback) {
      require('pygmentize-bundled')({ lang: lang, format: 'html' }, code, function (err, result) {
        callback(err, result.toString());
      });
    }
  });
  
  // Using async version of marked
  marked(markdownString, function (err, content) {
    if (err) throw err;
    console.log(content);
  });
  
  // Synchronous highlighting with highlight.js
  marked.setOptions({
    highlight: function (code) {
      return require('highlight.js').highlightAuto(code).value;
    }
  });
  
  console.log(marked(markdownString));
  ```
  
  #### highlight arguments
  
  `code`
  
  Type: `string`
  
  The section of code to pass to the highlighter.
  
  `lang`
  
  Type: `string`
  
  The programming language specified in the code block.
  
  `callback`
  
  Type: `function`
  
  The callback function to call when using an async highlighter.
  
  ### renderer
  
  Type: `object`
  Default: `new Renderer()`
  
  An object containing functions to render tokens to HTML.
  
  #### Overriding renderer methods
  
  The renderer option allows you to render tokens in a custom manner. Here is an
  example of overriding the default heading token rendering by adding an embedded anchor tag like on GitHub:
  
  ```javascript
  var marked = require('marked');
  var renderer = new marked.Renderer();
  
  renderer.heading = function (text, level) {
    var escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');
  
    return '<h' + level + '><a name="' +
                  escapedText +
                   '" class="anchor" href="#' +
                   escapedText +
                   '"><span class="header-link"></span></a>' +
                    text + '</h' + level + '>';
  },
  
  console.log(marked('# heading+', { renderer: renderer }));
  ```
  This code will output the following HTML:
  ```html
  <h1>
    <a name="heading-" class="anchor" href="#heading-">
      <span class="header-link"></span>
    </a>
    heading+
  </h1>
  ```
  
  #### Block level renderer methods
  
  - code(*string* code, *string* language)
  - blockquote(*string* quote)
  - html(*string* html)
  - heading(*string* text, *number*  level)
  - hr()
  - list(*string* body, *boolean* ordered)
  - listitem(*string*  text)
  - paragraph(*string* text)
  - table(*string* header, *string* body)
  - tablerow(*string* content)
  - tablecell(*string* content, *object* flags)
  
  `flags` has the following properties:
  
  ```js
  {
      header: true || false,
      align: 'center' || 'left' || 'right'
  }
  ```
  
  #### Inline level renderer methods
  
  - strong(*string* text)
  - em(*string* text)
  - codespan(*string* code)
  - br()
  - del(*string* text)
  - link(*string* href, *string* title, *string* text)
  - image(*string* href, *string* title, *string* text)
  
  ### gfm
  
  Type: `boolean`
  Default: `true`
  
  Enable [GitHub flavored markdown][gfm].
  
  ### tables
  
  Type: `boolean`
  Default: `true`
  
  Enable GFM [tables][tables].
  This option requires the `gfm` option to be true.
  
  ### breaks
  
  Type: `boolean`
  Default: `false`
  
  Enable GFM [line breaks][breaks].
  This option requires the `gfm` option to be true.
  
  ### pedantic
  
  Type: `boolean`
  Default: `false`
  
  Conform to obscure parts of `markdown.pl` as much as possible. Don't fix any of
  the original markdown bugs or poor behavior.
  
  ### sanitize
  
  Type: `boolean`
  Default: `false`
  
  Sanitize the output. Ignore any HTML that has been input.
  
  ### smartLists
  
  Type: `boolean`
  Default: `true`
  
  Use smarter list behavior than the original markdown. May eventually be
  default with the old behavior moved into `pedantic`.
  
  ### smartypants
  
  Type: `boolean`
  Default: `false`
  
  Use "smart" typograhic punctuation for things like quotes and dashes.
  
  ## Access to lexer and parser
  
  You also have direct access to the lexer and parser if you so desire.
  
  ``` js
  var tokens = marked.lexer(text, options);
  console.log(marked.parser(tokens));
  ```
  
  ``` js
  var lexer = new marked.Lexer(options);
  var tokens = lexer.lex(text);
  console.log(tokens);
  console.log(lexer.rules);
  ```
  
  ## CLI
  
  ``` bash
  $ marked -o hello.html
  hello world
  ^D
  $ cat hello.html
  <p>hello world</p>
  ```
  
  ## Philosophy behind marked
  
  The point of marked was to create a markdown compiler where it was possible to
  frequently parse huge chunks of markdown without having to worry about
  caching the compiled output somehow...or blocking for an unnecesarily long time.
  
  marked is very concise and still implements all markdown features. It is also
  now fully compatible with the client-side.
  
  marked more or less passes the official markdown test suite in its
  entirety. This is important because a surprising number of markdown compilers
  cannot pass more than a few tests. It was very difficult to get marked as
  compliant as it is. It could have cut corners in several areas for the sake
  of performance, but did not in order to be exactly what you expect in terms
  of a markdown rendering. In fact, this is why marked could be considered at a
  disadvantage in the benchmarks above.
  
  Along with implementing every markdown feature, marked also implements [GFM
  features][gfmf].
  
  ## Benchmarks
  
  node v0.8.x
  
  ``` bash
  $ node test --bench
  marked completed in 3411ms.
  marked (gfm) completed in 3727ms.
  marked (pedantic) completed in 3201ms.
  robotskirt completed in 808ms.
  showdown (reuse converter) completed in 11954ms.
  showdown (new converter) completed in 17774ms.
  markdown-js completed in 17191ms.
  ```
  
  __Marked is now faster than Discount, which is written in C.__
  
  For those feeling skeptical: These benchmarks run the entire markdown test suite 1000 times. The test suite tests every feature. It doesn't cater to specific aspects.
  
  ### Pro level
  
  You also have direct access to the lexer and parser if you so desire.
  
  ``` js
  var tokens = marked.lexer(text, options);
  console.log(marked.parser(tokens));
  ```
  
  ``` js
  var lexer = new marked.Lexer(options);
  var tokens = lexer.lex(text);
  console.log(tokens);
  console.log(lexer.rules);
  ```
  
  ``` bash
  $ node
  > require('marked').lexer('> i am using marked.')
  [ { type: 'blockquote_start' },
    { type: 'paragraph',
      text: 'i am using marked.' },
    { type: 'blockquote_end' },
    links: {} ]
  ```
  
  ## Running Tests & Contributing
  
  If you want to submit a pull request, make sure your changes pass the test
  suite. If you're adding a new feature, be sure to add your own test.
  
  The marked test suite is set up slightly strangely: `test/new` is for all tests
  that are not part of the original markdown.pl test suite (this is where your
  test should go if you make one). `test/original` is only for the original
  markdown.pl tests. `test/tests` houses both types of tests after they have been
  combined and moved/generated by running `node test --fix` or `marked --test
  --fix`.
  
  In other words, if you have a test to add, add it to `test/new/` and then
  regenerate the tests with `node test --fix`. Commit the result. If your test
  uses a certain feature, for example, maybe it assumes GFM is *not* enabled, you
  can add `.nogfm` to the filename. So, `my-test.text` becomes
  `my-test.nogfm.text`. You can do this with any marked option. Say you want
  line breaks and smartypants enabled, your filename should be:
  `my-test.breaks.smartypants.text`.
  
  To run the tests:
  
  ``` bash
  cd marked/
  node test
  ```
  
  ### Contribution and License Agreement
  
  If you contribute code to this project, you are implicitly allowing your code
  to be distributed under the MIT license. You are also implicitly verifying that
  all code is your original work. `</legalese>`
  
  ## License
  
  Copyright (c) 2011-2014, Christopher Jeffrey. (MIT License)
  
  See LICENSE for more info.
  
  [gfm]: https://help.github.com/articles/github-flavored-markdown
  [gfmf]: http://github.github.com/github-flavored-markdown/
  [pygmentize]: https://github.com/rvagg/node-pygmentize-bundled
  [highlight]: https://github.com/isagalaev/highlight.js
  [badge]: http://badge.fury.io/js/marked
  [tables]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#wiki-tables
  [breaks]: https://help.github.com/articles/github-flavored-markdown#newlines