aboutsummaryrefslogtreecommitdiff
path: root/tests/writer.rst
blob: 189886a87fadbd5ef99b893df445da807d88bd81 (plain)
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
=================
Pandoc Test Suite
=================

:Author: John MacFarlane
:Author: Anonymous
:Date:   July 17, 2006

.. role:: math(raw)
   :format: html latex

This is a set of tests for pandoc. Most of them are adapted from John Gruber’s
markdown test suite.

--------------

Headers
=======

Level 2 with an `embedded link </url>`_
---------------------------------------

Level 3 with *emphasis*
~~~~~~~~~~~~~~~~~~~~~~~

Level 4
^^^^^^^

Level 5
'''''''

Level 1
=======

Level 2 with *emphasis*
-----------------------

Level 3
~~~~~~~

with no blank line

Level 2
-------

with no blank line

--------------

Paragraphs
==========

Here’s a regular paragraph.

In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item.
Because a hard-wrapped line in the middle of a paragraph looked like a list
item.

Here’s one with a bullet. \* criminey.

There should be a hard line break
here.

--------------

Block Quotes
============

E-mail style:

    This is a block quote. It is pretty short.

    Code in a block quote:

    ::

        sub status {
            print "working";
        }

    A list:

    1. item one
    2. item two

    Nested block quotes:

        nested

        nested

This should not be a block quote: 2 > 1.

And a following paragraph.

--------------

Code Blocks
===========

Code:

::

    ---- (should be four hyphens)

    sub status {
        print "working";
    }

    this code block is indented by one tab

And:

::

        this code block is indented by two tabs

    These should not be escaped:  \$ \\ \> \[ \{

--------------

Lists
=====

Unordered
---------

Asterisks tight:

-  asterisk 1
-  asterisk 2
-  asterisk 3

Asterisks loose:

-  asterisk 1

-  asterisk 2

-  asterisk 3

Pluses tight:

-  Plus 1
-  Plus 2
-  Plus 3

Pluses loose:

-  Plus 1

-  Plus 2

-  Plus 3

Minuses tight:

-  Minus 1
-  Minus 2
-  Minus 3

Minuses loose:

-  Minus 1

-  Minus 2

-  Minus 3

Ordered
-------

Tight:

1. First
2. Second
3. Third

and:

1. One
2. Two
3. Three

Loose using tabs:

1. First

2. Second

3. Third

and using spaces:

1. One

2. Two

3. Three

Multiple paragraphs:

1. Item 1, graf one.

   Item 1. graf two. The quick brown fox jumped over the lazy dog’s back.

2. Item 2.

3. Item 3.

Nested
------

-  Tab

   -  Tab

      -  Tab

Here’s another:

1. First
2. Second:

   -  Fee
   -  Fie
   -  Foe

3. Third

Same thing but with paragraphs:

1. First

2. Second:

   -  Fee
   -  Fie
   -  Foe

3. Third

Tabs and spaces
---------------

-  this is a list item indented with tabs

-  this is a list item indented with spaces

   -  this is an example list item indented with tabs

   -  this is an example list item indented with spaces

Fancy list markers
------------------

(2) begins with 2
(3) and now 3

    with a continuation

    iv. sublist with roman numerals, starting with 4
    v.  more items

        (A) a subsublist
        (B) a subsublist

Nesting:

A. Upper Alpha

   I. Upper Roman.

      (6) Decimal start with 6

          c) Lower alpha with paren

Autonumbering:

#. Autonumber.
#. More.

   #. Nested.

Should not be a list item:

M.A. 2007

B. Williams

--------------

Definition Lists
================

Tight using spaces:

apple
    red fruit
orange
    orange fruit
banana
    yellow fruit

Tight using tabs:

apple
    red fruit
orange
    orange fruit
banana
    yellow fruit

Loose:

apple
    red fruit

orange
    orange fruit

banana
    yellow fruit

Multiple blocks with italics:

*apple*
    red fruit

    contains seeds, crisp, pleasant to taste

*orange*
    orange fruit

    ::

        { orange code block }

        orange block quote

Multiple definitions, tight:

apple
    red fruit
    computer
orange
    orange fruit
    bank

Multiple definitions, loose:

apple
    red fruit

    computer

orange
    orange fruit

    bank

Blank line after term, indented marker, alternate markers:

apple
    red fruit

    computer

orange
    orange fruit

    1. sublist
    2. sublist

HTML Blocks
===========

Simple block on one line:

.. raw:: html

   <div>

foo

.. raw:: html

   </div>

And nested without indentation:

.. raw:: html

   <div>
   <div>
   <div>

foo

.. raw:: html

   </div>
   </div>
   <div>

bar

.. raw:: html

   </div>
   </div>

Interpreted markdown in a table:

.. raw:: html

   <table>
   <tr>
   <td>

This is *emphasized*

.. raw:: html

   </td>
   <td>

And this is **strong**

.. raw:: html

   </td>
   </tr>
   </table>

   <script type="text/javascript">document.write('This *should not* be interpreted as markdown');</script>

Here’s a simple block:

.. raw:: html

   <div>
       

foo

.. raw:: html

   </div>

This should be a code block, though:

::

    <div>
        foo
    </div>

As should this:

::

    <div>foo</div>

Now, nested:

.. raw:: html

   <div>
       <div>
           <div>
               

foo

.. raw:: html

   </div>
       </div>
   </div>

This should just be an HTML comment:

.. raw:: html

   <!-- Comment -->

Multiline:

.. raw:: html

   <!--
   Blah
   Blah
   -->

   <!--
       This is another comment.
   -->

Code block:

::

    <!-- Comment -->

Just plain comment, with trailing spaces on the line:

.. raw:: html

   <!-- foo -->   

Code:

::

    <hr />

Hr’s:

.. raw:: html

   <hr>

   <hr />

   <hr />

   <hr>   

   <hr />  

   <hr /> 

   <hr class="foo" id="bar" />

   <hr class="foo" id="bar" />

   <hr class="foo" id="bar">

--------------

Inline Markup
=============

This is *emphasized*, and so *is this*.

This is **strong**, and so **is this**.

An *`emphasized link </url>`_*.

***This is strong and em.***

So is ***this*** word.

***This is strong and em.***

So is ***this*** word.

This is code: ``>``, ``$``, ``\``, ``\$``, ``<html>``.

[STRIKEOUT:This is *strikeout*.]

Superscripts: a\ :sup:`bc`\ d a\ :sup:`*hello*`\  a\ :sup:`hello there`\ .

Subscripts: H\ :sub:`2`\ O, H\ :sub:`23`\ O, H\ :sub:`many of them`\ O.

These should not be superscripts or subscripts, because of the unescaped
spaces: a^b c^d, a~b c~d.

--------------

Smart quotes, ellipses, dashes
==============================

“Hello,” said the spider. “‘Shelob’ is my name.”

‘A’, ‘B’, and ‘C’ are letters.

‘Oak,’ ‘elm,’ and ‘beech’ are names of trees. So is ‘pine.’

‘He said, “I want to go.”’ Were you alive in the 70’s?

Here is some quoted ‘``code``’ and a “`quoted
link <http://example.com/?foo=1&bar=2>`_”.

Some dashes: one—two — three—four — five.

Dashes between numbers: 5–7, 255–66, 1987–1999.

Ellipses…and…and….

--------------

LaTeX
=====

-  
-  :math:`$2+2=4$`
-  :math:`$x \in y$`
-  :math:`$\alpha \wedge \omega$`
-  :math:`$223$`
-  :math:`$p$`-Tree
-  Here’s some display math:
   :math:`$$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$$`
-  Here’s one that has a line break in it:
   :math:`$\alpha + \omega \times x^2$`.

These shouldn’t be math:

-  To get the famous equation, write ``$e = mc^2$``.
-  $22,000 is a *lot* of money. So is $34,000. (It worked if “lot” is
   emphasized.)
-  Shoes ($20) and socks ($5).
-  Escaped ``$``: $73 *this should be emphasized* 23$.

Here’s a LaTeX table:

.. raw:: latex

   \begin{tabular}{|l|l|}\hline
   Animal & Number \\ \hline
   Dog    & 2      \\
   Cat    & 1      \\ \hline
   \end{tabular}

--------------

Special Characters
==================

Here is some unicode:

-  I hat: Î
-  o umlaut: ö
-  section: §
-  set membership: ∈
-  copyright: ©

AT&T has an ampersand in their name.

AT&T is another way to write it.

This & that.

4 < 5.

6 > 5.

Backslash: \\

Backtick: \`

Asterisk: \*

Underscore: \_

Left brace: {

Right brace: }

Left bracket: [

Right bracket: ]

Left paren: (

Right paren: )

Greater-than: >

Hash: #

Period: .

Bang: !

Plus: +

Minus: -

--------------

Links
=====

Explicit
--------

Just a `URL </url/>`_.

`URL and title </url/>`_.

`URL and title </url/>`_.

`URL and title </url/>`_.

`URL and title </url/>`_

`URL and title </url/>`_

`with\_underscore </url/with_underscore>`_

`Email link <mailto:nobody@nowhere.net>`_

`Empty <>`_.

Reference
---------

Foo `bar </url/>`_.

Foo `bar </url/>`_.

Foo `bar </url/>`_.

With `embedded [brackets] </url/>`_.

`b </url/>`_ by itself should be a link.

Indented `once </url>`_.

Indented `twice </url>`_.

Indented `thrice </url>`_.

This should [not][] be a link.

::

    [not]: /url

Foo `bar </url/>`_.

Foo `biz </url/>`_.

With ampersands
---------------

Here’s a `link with an ampersand in the
URL <http://example.com/?foo=1&bar=2>`_.

Here’s a link with an amersand in the link text: `AT&T <http://att.com/>`_.

Here’s an `inline link </script?foo=1&bar=2>`_.

Here’s an `inline link in pointy braces </script?foo=1&bar=2>`_.

Autolinks
---------

With an ampersand: http://example.com/?foo=1&bar=2

-  In a list?
-  http://example.com/
-  It should.

An e-mail address: nobody@nowhere.net

    Blockquoted: http://example.com/

Auto-links should not occur here: ``<http://example.com/>``

::

    or here: <http://example.com/>

--------------

Images
======

From “Voyage dans la Lune” by Georges Melies (1902):

.. figure:: lalune.jpg
   :align: center
   :alt: Voyage dans la Lune

   lalune
Here is a movie |movie| icon.

--------------

Footnotes
=========

Here is a footnote reference, [1]_ and another. [2]_ This should *not* be a
footnote reference, because it contains a space.[^my note] Here is an inline
note. [3]_

    Notes can go in quotes. [4]_

1. And in list items. [5]_

This paragraph should not be part of the note, as it is not indented.

.. [1]
   Here is the footnote. It can go anywhere after the footnote reference. It
   need not be placed at the end of the document.

.. [2]
   Here’s the long note. This one contains multiple blocks.

   Subsequent blocks are indented to show that they belong to the footnote (as
   with list items).

   ::

         { <code> }

   If you want, you can indent every line, but you can also be lazy and just
   indent the first line of each block.

.. [3]
   This is *easier* to type. Inline notes may contain
   `links <http://google.com>`_ and ``]`` verbatim characters, as well as
   [bracketed text].

.. [4]
   In quote.

.. [5]
   In list.

.. |movie| image:: movie.jpg