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
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
|
---
title: Pandoc User's Guide
author: John MacFarlane
date: March 20, 2021
---
# Synopsis
`pandoc` [*options*] [*input-file*]...
# Description
Pandoc is a [Haskell] library for converting from one markup format to
another, and a command-line tool that uses this library.
Pandoc can convert between numerous markup and word processing formats,
including, but not limited to, various flavors of [Markdown], [HTML],
[LaTeX] and [Word docx]. For the full lists of input and output formats,
see the `--from` and `--to` [options below][General options].
Pandoc can also produce [PDF] output: see [creating a PDF], below.
Pandoc's enhanced version of Markdown includes syntax for [tables],
[definition lists], [metadata blocks], [footnotes], [citations], [math],
and much more. See below under [Pandoc's Markdown].
Pandoc has a modular design: it consists of a set of readers, which parse
text in a given format and produce a native representation of the document
(an _abstract syntax tree_ or AST), and a set of writers, which convert
this native representation into a target format. Thus, adding an input
or output format requires only adding a reader or writer. Users can also
run custom [pandoc filters] to modify the intermediate AST.
Because pandoc's intermediate representation of a document is less
expressive than many of the formats it converts between, one should
not expect perfect conversions between every format and every other.
Pandoc attempts to preserve the structural elements of a document, but
not formatting details such as margin size. And some document elements,
such as complex tables, may not fit into pandoc's simple document
model. While conversions from pandoc's Markdown to all formats aspire
to be perfect, conversions from formats more expressive than pandoc's
Markdown can be expected to be lossy.
## Using pandoc
If no *input-files* are specified, input is read from *stdin*.
Output goes to *stdout* by default. For output to a file,
use the `-o` option:
pandoc -o output.html input.txt
By default, pandoc produces a document fragment. To produce a standalone
document (e.g. a valid HTML file including `<head>` and `<body>`),
use the `-s` or `--standalone` flag:
pandoc -s -o output.html input.txt
For more information on how standalone documents are produced, see
[Templates] below.
If multiple input files are given, `pandoc` will concatenate them all (with
blank lines between them) before parsing. (Use `--file-scope` to parse files
individually.)
## Specifying formats
The format of the input and output can be specified explicitly using
command-line options. The input format can be specified using the
`-f/--from` option, the output format using the `-t/--to` option.
Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
pandoc -f markdown -t latex hello.txt
To convert `hello.html` from HTML to Markdown:
pandoc -f html -t markdown hello.html
Supported input and output formats are listed below under [Options]
(see `-f` for input formats and `-t` for output formats). You
can also use `pandoc --list-input-formats` and
`pandoc --list-output-formats` to print lists of supported
formats.
If the input or output format is not specified explicitly, `pandoc`
will attempt to guess it from the extensions of the filenames.
Thus, for example,
pandoc -o hello.tex hello.txt
will convert `hello.txt` from Markdown to LaTeX. If no output file
is specified (so that output goes to *stdout*), or if the output file's
extension is unknown, the output format will default to HTML.
If no input file is specified (so that input comes from *stdin*), or
if the input files' extensions are unknown, the input format will
be assumed to be Markdown.
## Character encoding
Pandoc uses the UTF-8 character encoding for both input and output.
If your local character encoding is not UTF-8, you
should pipe input and output through [`iconv`]:
iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
Note that in some output formats (such as HTML, LaTeX, ConTeXt,
RTF, OPML, DocBook, and Texinfo), information about
the character encoding is included in the document header, which
will only be included if you use the `-s/--standalone` option.
[`iconv`]: https://www.gnu.org/software/libiconv/
## Creating a PDF
To produce a PDF, specify an output file with a `.pdf` extension:
pandoc test.txt -o test.pdf
By default, pandoc will use LaTeX to create the PDF, which requires
that a LaTeX engine be installed (see `--pdf-engine` below).
Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
intermediate format. To do this, specify an output file with a
`.pdf` extension, as before, but add the `--pdf-engine` option
or `-t context`, `-t html`, or `-t ms` to the command line.
The tool used to generate the PDF from the intermediate format
may be specified using `--pdf-engine`.
You can control the PDF style using variables, depending on
the intermediate format used: see [variables for LaTeX],
[variables for ConTeXt], [variables for `wkhtmltopdf`],
[variables for ms]. When HTML is used as an intermediate
format, the output can be styled using `--css`.
To debug the PDF creation, it can be useful to look at the intermediate
representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
When using LaTeX, the following packages need to be available
(they are included with all recent versions of [TeX Live]):
[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
[`iftex`], [`listings`] (if the
`--listings` option is used), [`fancyvrb`], [`longtable`],
[`booktabs`], [`graphicx`] (if the document
contains images), [`hyperref`], [`xcolor`],
[`ulem`], [`geometry`] (with the `geometry` variable set),
[`setspace`] (with `linestretch`), and
[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
the PDF engine requires [`fontspec`]. `lualatex` uses
[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
`mathspec` variable is set, `xelatex` will use [`mathspec`]
instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
packages are used if available, and [`csquotes`] will be used
for [typography] if the `csquotes` variable or metadata field is
set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
and [`biber`] packages can optionally be used for [citation
rendering]. The following packages will be used to improve
output quality if present, but pandoc does not require them to
be present: [`upquote`] (for straight quotes in verbatim
environments), [`microtype`] (for better spacing adjustments),
[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
better line breaks in URLs), [`bookmark`] (for better PDF
bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
footnotes in tables).
[TeX Live]: https://www.tug.org/texlive/
[`amsfonts`]: https://ctan.org/pkg/amsfonts
[`amsmath`]: https://ctan.org/pkg/amsmath
[`babel`]: https://ctan.org/pkg/babel
[`biber`]: https://ctan.org/pkg/biber
[`biblatex`]: https://ctan.org/pkg/biblatex
[`bibtex`]: https://ctan.org/pkg/bibtex
[`bidi`]: https://ctan.org/pkg/bidi
[`bookmark`]: https://ctan.org/pkg/bookmark
[`booktabs`]: https://ctan.org/pkg/booktabs
[`csquotes`]: https://ctan.org/pkg/csquotes
[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
[`fontspec`]: https://ctan.org/pkg/fontspec
[`footnote`]: https://ctan.org/pkg/footnote
[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
[`geometry`]: https://ctan.org/pkg/geometry
[`graphicx`]: https://ctan.org/pkg/graphicx
[`grffile`]: https://ctan.org/pkg/grffile
[`hyperref`]: https://ctan.org/pkg/hyperref
[`iftex`]: https://ctan.org/pkg/iftex
[`listings`]: https://ctan.org/pkg/listings
[`lm`]: https://ctan.org/pkg/lm
[`longtable`]: https://ctan.org/pkg/longtable
[`mathspec`]: https://ctan.org/pkg/mathspec
[`microtype`]: https://ctan.org/pkg/microtype
[`natbib`]: https://ctan.org/pkg/natbib
[`parskip`]: https://ctan.org/pkg/parskip
[`polyglossia`]: https://ctan.org/pkg/polyglossia
[`prince`]: https://www.princexml.com/
[`setspace`]: https://ctan.org/pkg/setspace
[`ulem`]: https://ctan.org/pkg/ulem
[`unicode-math`]: https://ctan.org/pkg/unicode-math
[`upquote`]: https://ctan.org/pkg/upquote
[`weasyprint`]: https://weasyprint.org
[`wkhtmltopdf`]: https://wkhtmltopdf.org
[`xcolor`]: https://ctan.org/pkg/xcolor
[`xecjk`]: https://ctan.org/pkg/xecjk
[`xurl`]: https://ctan.org/pkg/xurl
[`selnolig`]: https://ctan.org/pkg/selnolig
## Reading from the Web
Instead of an input file, an absolute URI may be given. In this case
pandoc will fetch the content using HTTP:
pandoc -f html -t markdown https://www.fsf.org
It is possible to supply a custom User-Agent string or other
header when requesting a document from a URL:
pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
https://www.fsf.org
# Options
## General options {.options}
`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
: Specify input format. *FORMAT* can be:
::: {#input-formats}
- `bibtex` ([BibTeX] bibliography)
- `biblatex` ([BibLaTeX] bibliography)
- `commonmark` ([CommonMark] Markdown)
- `commonmark_x` ([CommonMark] Markdown with extensions)
- `creole` ([Creole 1.0])
- `csljson` ([CSL JSON] bibliography)
- `csv` ([CSV] table)
- `docbook` ([DocBook])
- `docx` ([Word docx])
- `dokuwiki` ([DokuWiki markup])
- `epub` ([EPUB])
- `fb2` ([FictionBook2] e-book)
- `gfm` ([GitHub-Flavored Markdown]),
or the deprecated and less accurate `markdown_github`;
use [`markdown_github`](#markdown-variants) only
if you need extensions not supported in [`gfm`](#markdown-variants).
- `haddock` ([Haddock markup])
- `html` ([HTML])
- `ipynb` ([Jupyter notebook])
- `jats` ([JATS] XML)
- `jira` ([Jira]/Confluence wiki markup)
- `json` (JSON version of native AST)
- `latex` ([LaTeX])
- `markdown` ([Pandoc's Markdown])
- `markdown_mmd` ([MultiMarkdown])
- `markdown_phpextra` ([PHP Markdown Extra])
- `markdown_strict` (original unextended [Markdown])
- `mediawiki` ([MediaWiki markup])
- `man` ([roff man])
- `muse` ([Muse])
- `native` (native Haskell)
- `odt` ([ODT])
- `opml` ([OPML])
- `org` ([Emacs Org mode])
- `rst` ([reStructuredText])
- `t2t` ([txt2tags])
- `textile` ([Textile])
- `tikiwiki` ([TikiWiki markup])
- `twiki` ([TWiki markup])
- `vimwiki` ([Vimwiki])
:::
Extensions can be individually enabled or disabled by
appending `+EXTENSION` or `-EXTENSION` to the format name.
See [Extensions] below, for a list of extensions and
their names. See `--list-input-formats` and `--list-extensions`,
below.
`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
: Specify output format. *FORMAT* can be:
::: {#output-formats}
- `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
- `beamer` ([LaTeX beamer][`beamer`] slide show)
- `bibtex` ([BibTeX] bibliography)
- `biblatex` ([BibLaTeX] bibliography)
- `commonmark` ([CommonMark] Markdown)
- `commonmark_x` ([CommonMark] Markdown with extensions)
- `context` ([ConTeXt])
- `csljson` ([CSL JSON] bibliography)
- `docbook` or `docbook4` ([DocBook] 4)
- `docbook5` (DocBook 5)
- `docx` ([Word docx])
- `dokuwiki` ([DokuWiki markup])
- `epub` or `epub3` ([EPUB] v3 book)
- `epub2` (EPUB v2)
- `fb2` ([FictionBook2] e-book)
- `gfm` ([GitHub-Flavored Markdown]),
or the deprecated and less accurate `markdown_github`;
use [`markdown_github`](#markdown-variants) only
if you need extensions not supported in [`gfm`](#markdown-variants).
- `haddock` ([Haddock markup])
- `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
- `html4` ([XHTML] 1.0 Transitional)
- `icml` ([InDesign ICML])
- `ipynb` ([Jupyter notebook])
- `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
- `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
- `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
- `jats` (alias for `jats_archiving`)
- `jira` ([Jira]/Confluence wiki markup)
- `json` (JSON version of native AST)
- `latex` ([LaTeX])
- `man` ([roff man])
- `markdown` ([Pandoc's Markdown])
- `markdown_mmd` ([MultiMarkdown])
- `markdown_phpextra` ([PHP Markdown Extra])
- `markdown_strict` (original unextended [Markdown])
- `mediawiki` ([MediaWiki markup])
- `ms` ([roff ms])
- `muse` ([Muse]),
- `native` (native Haskell),
- `odt` ([OpenOffice text document][ODT])
- `opml` ([OPML])
- `opendocument` ([OpenDocument])
- `org` ([Emacs Org mode])
- `pdf` ([PDF])
- `plain` (plain text),
- `pptx` ([PowerPoint] slide show)
- `rst` ([reStructuredText])
- `rtf` ([Rich Text Format])
- `texinfo` ([GNU Texinfo])
- `textile` ([Textile])
- `slideous` ([Slideous] HTML and JavaScript slide show)
- `slidy` ([Slidy] HTML and JavaScript slide show)
- `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
- `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
- `s5` ([S5] HTML and JavaScript slide show)
- `tei` ([TEI Simple])
- `xwiki` ([XWiki markup])
- `zimwiki` ([ZimWiki markup])
- the path of a custom Lua writer, see [Custom writers] below
:::
Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
to *stdout* unless forced with `-o -`.
Extensions can be individually enabled or
disabled by appending `+EXTENSION` or `-EXTENSION` to the format
name. See [Extensions] below, for a list of extensions and their
names. See `--list-output-formats` and `--list-extensions`, below.
`-o` *FILE*, `--output=`*FILE*
: Write output to *FILE* instead of *stdout*. If *FILE* is
`-`, output will go to *stdout*, even if a non-textual format
(`docx`, `odt`, `epub2`, `epub3`) is specified.
`--data-dir=`*DIRECTORY*
: Specify the user data directory to search for pandoc data files.
If this option is not specified, the default user data directory
will be used. On \*nix and macOS systems this will be the `pandoc`
subdirectory of the XDG data directory (by default,
`$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
environment variable). If that directory does not exist and
`$HOME/.pandoc` exists, it will be used (for backwards compatibility).
On Windows the default user data directory is
`C:\Users\USERNAME\AppData\Roaming\pandoc`.
You can find the default user data directory on your system by
looking at the output of `pandoc --version`.
Data files placed in this directory (for example, `reference.odt`,
`reference.docx`, `epub.css`, `templates`) will override
pandoc's normal defaults.
`-d` *FILE*, `--defaults=`*FILE*
: Specify a set of default option settings. *FILE* is a YAML
file whose fields correspond to command-line option
settings. All options for document conversion, including input
and output files, can be set using a defaults file. The file will
be searched for first in the working directory, and then in
the `defaults` subdirectory of the user data directory
(see `--data-dir`). The `.yaml` extension may be omitted.
See the section [Default files] for more information on the
file format. Settings from the defaults file may be
overridden or extended by subsequent options on the command
line.
`--bash-completion`
: Generate a bash completion script. To enable bash completion
with pandoc, add this to your `.bashrc`:
eval "$(pandoc --bash-completion)"
`--verbose`
: Give verbose debugging output.
`--quiet`
: Suppress warning messages.
`--fail-if-warnings`
: Exit with error status if there are any warnings.
`--log=`*FILE*
: Write log messages in machine-readable JSON format to
*FILE*. All messages above DEBUG level will be written,
regardless of verbosity settings (`--verbose`, `--quiet`).
`--list-input-formats`
: List supported input formats, one per line.
`--list-output-formats`
: List supported output formats, one per line.
`--list-extensions`[`=`*FORMAT*]
: List supported extensions for *FORMAT*, one per line, preceded
by a `+` or `-` indicating whether it is enabled by default
in *FORMAT*. If *FORMAT* is not specified, defaults for
pandoc's Markdown are given.
`--list-highlight-languages`
: List supported languages for syntax highlighting, one per
line.
`--list-highlight-styles`
: List supported styles for syntax highlighting, one per line.
See `--highlight-style`.
`-v`, `--version`
: Print version.
`-h`, `--help`
: Show usage message.
[Markdown]: https://daringfireball.net/projects/markdown/
[CommonMark]: https://commonmark.org
[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
[S5]: https://meyerweb.com/eric/tools/s5/
[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
[Slideous]: https://goessner.net/articles/slideous/
[HTML]: https://www.w3.org/html/
[HTML5]: https://html.spec.whatwg.org/
[polyglot markup]: https://www.w3.org/TR/html-polyglot/
[XHTML]: https://www.w3.org/TR/xhtml1/
[LaTeX]: https://www.latex-project.org/
[`beamer`]: https://ctan.org/pkg/beamer
[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
[ConTeXt]: https://www.contextgarden.net/
[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
[DocBook]: https://docbook.org
[JATS]: https://jats.nlm.nih.gov
[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
[txt2tags]: https://txt2tags.org
[EPUB]: http://idpf.org/epub
[OPML]: http://dev.opml.org/spec2.html
[OpenDocument]: http://opendocument.xml.org
[ODT]: https://en.wikipedia.org/wiki/OpenDocument
[Textile]: https://www.promptworks.com/textile
[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
[CSV]: https://tools.ietf.org/html/rfc4180
[roff man]: https://man.cx/groff_man(7)
[roff ms]: https://man.cx/groff_ms(7)
[Haskell]: https://www.haskell.org
[GNU Texinfo]: https://www.gnu.org/software/texinfo/
[Emacs Org mode]: https://orgmode.org
[AsciiDoc]: https://www.methods.co.nz/asciidoc/
[AsciiDoctor]: https://asciidoctor.org/
[DZSlides]: https://paulrouget.com/dzslides/
[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
[PDF]: https://www.adobe.com/pdf/
[reveal.js]: https://revealjs.com/
[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
[TEI Simple]: https://github.com/TEIC/TEI-Simple
[Muse]: https://amusewiki.org/library/manual
[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
[Vimwiki]: https://vimwiki.github.io
[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
[BibTeX]: https://ctan.org/pkg/bibtex
[BibLaTeX]: https://ctan.org/pkg/biblatex
## Reader options {.options}
`--shift-heading-level-by=`*NUMBER*
: Shift heading levels by a positive or negative integer.
For example, with `--shift-heading-level-by=-1`, level 2
headings become level 1 headings, and level 3 headings
become level 2 headings. Headings cannot have a level
less than 1, so a heading that would be shifted below level 1
becomes a regular paragraph. Exception: with a shift of -N,
a level-N heading at the beginning of the document
replaces the metadata title. `--shift-heading-level-by=-1`
is a good choice when converting HTML or Markdown documents that
use an initial level-1 heading for the document title and
level-2+ headings for sections. `--shift-heading-level-by=1`
may be a good choice for converting Markdown documents that
use level-1 headings for sections to HTML, since pandoc uses
a level-1 heading to render the document title.
`--base-header-level=`*NUMBER*
: *Deprecated. Use `--shift-heading-level-by`=X instead,
where X = NUMBER - 1.* Specify the base level for headings
(defaults to 1).
`--strip-empty-paragraphs`
: *Deprecated. Use the `+empty_paragraphs` extension instead.*
Ignore paragraphs with no content. This option is useful
for converting word processing documents where users have
used empty paragraphs to create inter-paragraph space.
`--indented-code-classes=`*CLASSES*
: Specify classes to use for indented code blocks--for example,
`perl,numberLines` or `haskell`. Multiple classes may be separated
by spaces or commas.
`--default-image-extension=`*EXTENSION*
: Specify a default extension to use when image paths/URLs have no
extension. This allows you to use the same source for formats that
require different kinds of images. Currently this option only affects
the Markdown and LaTeX readers.
`--file-scope`
: Parse each file individually before combining for multifile
documents. This will allow footnotes in different files with the
same identifiers to work as expected. If this option is set,
footnotes and links will not work across files. Reading binary
files (docx, odt, epub) implies `--file-scope`.
`-F` *PROGRAM*, `--filter=`*PROGRAM*
: Specify an executable to be used as a filter transforming the
pandoc AST after the input is parsed and before the output is
written. The executable should read JSON from stdin and write
JSON to stdout. The JSON must be formatted like pandoc's own
JSON input and output. The name of the output format will be
passed to the filter as the first argument. Hence,
pandoc --filter ./caps.py -t latex
is equivalent to
pandoc -t json | ./caps.py latex | pandoc -f json -t latex
The latter form may be useful for debugging filters.
Filters may be written in any language. `Text.Pandoc.JSON`
exports `toJSONFilter` to facilitate writing filters in Haskell.
Those who would prefer to write filters in python can use the
module [`pandocfilters`], installable from PyPI. There are also
pandoc filter libraries in [PHP], [perl], and
[JavaScript/node.js].
In order of preference, pandoc will look for filters in
1. a specified full or relative path (executable or
non-executable)
2. `$DATADIR/filters` (executable or non-executable)
where `$DATADIR` is the user data directory (see
`--data-dir`, above).
3. `$PATH` (executable only)
Filters, Lua-filters, and citeproc processing are applied in
the order specified on the command line.
`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
: Transform the document in a similar fashion as JSON filters (see
`--filter`), but use pandoc's built-in Lua filtering system. The given
Lua script is expected to return a list of Lua filters which will be
applied in order. Each Lua filter must contain element-transforming
functions indexed by the name of the AST element on which the filter
function should be applied.
The `pandoc` Lua module provides helper functions for element
creation. It is always loaded into the script's Lua environment.
See the [Lua filters documentation] for further details.
In order of preference, pandoc will look for Lua filters in
1. a specified full or relative path
2. `$DATADIR/filters` where `$DATADIR` is the user data
directory (see `--data-dir`, above).
Filters, Lua filters, and citeproc processing are applied in
the order specified on the command line.
`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
: Set the metadata field *KEY* to the value *VAL*. A value specified
on the command line overrides a value specified in the document
using [YAML metadata blocks][Extension: `yaml_metadata_block`].
Values will be parsed as YAML boolean or string values. If no value is
specified, the value will be treated as Boolean true. Like
`--variable`, `--metadata` causes template variables to be set.
But unlike `--variable`, `--metadata` affects the metadata of the
underlying document (which is accessible from filters and may be
printed in some output formats) and metadata values will be escaped
when inserted into the template.
`--metadata-file=`*FILE*
: Read metadata from the supplied YAML (or JSON) file. This
option can be used with every input format, but string scalars
in the YAML file will always be parsed as Markdown. Generally,
the input will be handled the same as in [YAML metadata
blocks][Extension: `yaml_metadata_block`]. This option can be
used repeatedly to include multiple metadata files; values in
files specified later on the command line will be preferred
over those specified in earlier files. Metadata values
specified inside the document, or by using `-M`, overwrite
values specified with this option.
`-p`, `--preserve-tabs`
: Preserve tabs instead of converting them to spaces. (By default, pandoc
converts tabs to spaces before parsing its input.) Note that this will
only affect tabs in literal code spans and code blocks. Tabs in regular
text are always treated as spaces.
`--tab-stop=`*NUMBER*
: Specify the number of spaces per tab (default is 4).
`--track-changes=accept`|`reject`|`all`
: Specifies what to do with insertions, deletions, and comments
produced by the MS Word "Track Changes" feature. `accept` (the
default) processes all the insertions and deletions.
`reject` ignores them. Both `accept` and `reject` ignore comments.
`all` includes all insertions, deletions, and comments, wrapped
in spans with `insertion`, `deletion`, `comment-start`, and
`comment-end` classes, respectively. The author and time of
change is included. `all` is useful for scripting: only
accepting changes from a certain reviewer, say, or before a
certain date. If a paragraph is inserted or deleted,
`track-changes=all` produces a span with the class
`paragraph-insertion`/`paragraph-deletion` before the
affected paragraph break. This option only affects the docx
reader.
`--extract-media=`*DIR*
: Extract images and other media contained in or linked from
the source document to the path *DIR*, creating it if
necessary, and adjust the images references in the document
so they point to the extracted files. If the source format is
a binary container (docx, epub, or odt), the media is
extracted from the container and the original
filenames are used. Otherwise the media is read from the
file system or downloaded, and new filenames are constructed
based on SHA1 hashes of the contents.
`--abbreviations=`*FILE*
: Specifies a custom abbreviations file, with abbreviations
one to a line. If this option is not specified, pandoc will
read the data file `abbreviations` from the user data
directory or fall back on a system default. To see the
system default, use
`pandoc --print-default-data-file=abbreviations`. The only
use pandoc makes of this list is in the Markdown reader.
Strings found in this list will be followed by a nonbreaking
space, and the period will not produce sentence-ending space
in formats like LaTeX. The strings may not contain spaces.
[`pandocfilters`]: https://github.com/jgm/pandocfilters
[PHP]: https://github.com/vinai/pandocfilters-php
[perl]: https://metacpan.org/pod/Pandoc::Filter
[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
[Lua filters documentation]: https://pandoc.org/lua-filters.html
## General writer options {.options}
`-s`, `--standalone`
: Produce output with an appropriate header and footer (e.g. a
standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
output. For `native` output, this option causes metadata to
be included; otherwise, metadata is suppressed.
`--template=`*FILE*|*URL*
: Use the specified file as a custom template for the generated document.
Implies `--standalone`. See [Templates], below, for a description
of template syntax. If no extension is specified, an extension
corresponding to the writer will be added, so that `--template=special`
looks for `special.html` for HTML output. If the template is not
found, pandoc will search for it in the `templates` subdirectory of
the user data directory (see `--data-dir`). If this option is not used,
a default template appropriate for the output format will be used (see
`-D/--print-default-template`).
`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
: Set the template variable *KEY* to the value *VAL* when rendering the
document in standalone mode. If no *VAL* is specified, the
key will be given the value `true`.
`-D` *FORMAT*, `--print-default-template=`*FORMAT*
: Print the system default template for an output *FORMAT*. (See `-t`
for a list of possible *FORMAT*s.) Templates in the user data
directory are ignored. This option may be used with
`-o`/`--output` to redirect output to a file, but
`-o`/`--output` must come before `--print-default-template`
on the command line.
Note that some of the default templates use partials, for
example `styles.html`. To print the partials, use
`--print-default-data-file`: for example,
`--print-default-data-file=templates/styles.html`.
`--print-default-data-file=`*FILE*
: Print a system default data file. Files in the user data directory
are ignored. This option may be used with `-o`/`--output` to
redirect output to a file, but `-o`/`--output` must come before
`--print-default-data-file` on the command line.
`--eol=crlf`|`lf`|`native`
: Manually specify line endings: `crlf` (Windows), `lf`
(macOS/Linux/UNIX), or `native` (line endings appropriate
to the OS on which pandoc is being run). The default is
`native`.
`--dpi`=*NUMBER*
: Specify the default dpi (dots per inch) value for conversion
from pixels to inch/centimeters and vice versa. (Technically,
the correct term would be ppi: pixels per inch.) The default
is 96dpi. When images contain information about dpi
internally, the encoded value is used instead of the default
specified by this option.
`--wrap=auto`|`none`|`preserve`
: Determine how text is wrapped in the output (the source
code, not the rendered version). With `auto` (the default),
pandoc will attempt to wrap lines to the column width specified by
`--columns` (default 72). With `none`, pandoc will not wrap
lines at all. With `preserve`, pandoc will attempt to
preserve the wrapping from the source document (that is,
where there are nonsemantic newlines in the source, there
will be nonsemantic newlines in the output as well).
Automatic wrapping does not currently work in HTML output.
In `ipynb` output, this option affects wrapping of the
contents of markdown cells.
`--columns=`*NUMBER*
: Specify length of lines in characters. This affects text wrapping
in the generated source code (see `--wrap`). It also affects
calculation of column widths for plain text tables (see [Tables] below).
`--toc`, `--table-of-contents`
: Include an automatically generated table of contents (or, in
the case of `latex`, `context`, `docx`, `odt`,
`opendocument`, `rst`, or `ms`, an instruction to create
one) in the output document. This option has no effect
unless `-s/--standalone` is used, and it has no effect
on `man`, `docbook4`, `docbook5`, or `jats` output.
Note that if you are producing a PDF via `ms`, the table
of contents will appear at the beginning of the
document, before the title. If you would prefer it to
be at the end of the document, use the option
`--pdf-engine-opt=--no-toc-relocation`.
`--toc-depth=`*NUMBER*
: Specify the number of section levels to include in the table
of contents. The default is 3 (which means that level-1, 2, and 3
headings will be listed in the contents).
`--strip-comments`
: Strip out HTML comments in the Markdown or Textile source,
rather than passing them on to Markdown, Textile or HTML
output as raw HTML. This does not apply to HTML comments
inside raw HTML blocks when the `markdown_in_html_blocks`
extension is not set.
`--no-highlight`
: Disables syntax highlighting for code blocks and inlines, even when
a language attribute is given.
`--highlight-style=`*STYLE*|*FILE*
: Specifies the coloring style to be used in highlighted source code.
Options are `pygments` (the default), `kate`, `monochrome`,
`breezeDark`, `espresso`, `zenburn`, `haddock`, and `tango`.
For more information on syntax highlighting in pandoc, see
[Syntax highlighting], below. See also
`--list-highlight-styles`.
Instead of a *STYLE* name, a JSON file with extension
`.theme` may be supplied. This will be parsed as a KDE
syntax highlighting theme and (if valid) used as the
highlighting style.
To generate the JSON version of an existing style,
use `--print-highlight-style`.
`--print-highlight-style=`*STYLE*|*FILE*
: Prints a JSON version of a highlighting style, which can
be modified, saved with a `.theme` extension, and used
with `--highlight-style`. This option may be used with
`-o`/`--output` to redirect output to a file, but
`-o`/`--output` must come before `--print-highlight-style`
on the command line.
`--syntax-definition=`*FILE*
: Instructs pandoc to load a KDE XML syntax definition file,
which will be used for syntax highlighting of appropriately
marked code blocks. This can be used to add support for
new languages or to use altered syntax definitions for
existing languages. This option may be repeated to add
multiple syntax definitions.
`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
: Include contents of *FILE*, verbatim, at the end of the header.
This can be used, for example, to include special
CSS or JavaScript in HTML documents. This option can be used
repeatedly to include multiple files in the header. They will be
included in the order specified. Implies `--standalone`.
`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
: Include contents of *FILE*, verbatim, at the beginning of the
document body (e.g. after the `<body>` tag in HTML, or the
`\begin{document}` command in LaTeX). This can be used to include
navigation bars or banners in HTML documents. This option can be
used repeatedly to include multiple files. They will be included in
the order specified. Implies `--standalone`.
`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
: Include contents of *FILE*, verbatim, at the end of the document
body (before the `</body>` tag in HTML, or the
`\end{document}` command in LaTeX). This option can be used
repeatedly to include multiple files. They will be included in the
order specified. Implies `--standalone`.
`--resource-path=`*SEARCHPATH*
: List of paths to search for images and other resources.
The paths should be separated by `:` on Linux, UNIX, and
macOS systems, and by `;` on Windows. If `--resource-path`
is not specified, the default resource path is the working
directory. Note that, if `--resource-path` is specified,
the working directory must be explicitly listed or it
will not be searched. For example:
`--resource-path=.:test` will search the working directory
and the `test` subdirectory, in that order.
This option can be used repeatedly. Search path components
that come later on the command line will be searched before
those that come earlier, so
`--resource-path foo:bar --resource-path baz:bim` is
equivalent to `--resource-path baz:bim:foo:bar`.
`--request-header=`*NAME*`:`*VAL*
: Set the request header *NAME* to the value *VAL* when making
HTTP requests (for example, when a URL is given on the
command line, or when resources used in a document must be
downloaded). If you're behind a proxy, you also need to set
the environment variable `http_proxy` to `http://...`.
`--no-check-certificate`
: Disable the certificate verification to allow access to
unsecure HTTP resources (for example when the certificate
is no longer valid or self signed).
## Options affecting specific writers {.options}
`--self-contained`
: Produce a standalone HTML file with no external dependencies, using
`data:` URIs to incorporate the contents of linked scripts, stylesheets,
images, and videos. Implies `--standalone`. The resulting file should be
"self-contained," in the sense that it needs no external files and no net
access to be displayed properly by a browser. This option works only with
HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
`s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
and stylesheets at absolute URLs will be downloaded; those at relative
URLs will be sought relative to the working directory (if the first source
file is local) or relative to the base URL (if the first source
file is remote). Elements with the attribute
`data-external="1"` will be left alone; the documents they
link to will not be incorporated in the document.
Limitation: resources that are loaded dynamically through
JavaScript cannot be incorporated; as a result,
`--self-contained` does not work with `--mathjax`, and some
advanced features (e.g. zoom or speaker notes) may not work
in an offline "self-contained" `reveal.js` slide show.
`--html-q-tags`
: Use `<q>` tags for quotes in HTML. (This option only has an
effect if the `smart` extension is enabled for the input
format used.)
`--ascii`
: Use only ASCII characters in output. Currently supported for XML
and HTML formats (which use entities instead of UTF-8 when this
option is selected), CommonMark, gfm, and Markdown (which use
entities), roff ms (which use hexadecimal escapes), and to a
limited degree LaTeX (which uses standard commands for accented
characters when possible). roff man output uses ASCII by default.
`--reference-links`
: Use reference-style links, rather than inline links, in writing Markdown
or reStructuredText. By default inline links are used. The
placement of link references is affected by the
`--reference-location` option.
`--reference-location=block`|`section`|`document`
: Specify whether footnotes (and references, if `reference-links` is
set) are placed at the end of the current (top-level) block, the
current section, or the document. The default is
`document`. Currently only affects the markdown writer.
`--markdown-headings=setext`|`atx`
: Specify whether to use ATX-style (`#`-prefixed) or
Setext-style (underlined) headings for level 1 and 2
headings in Markdown output. (The default is `atx`.)
ATX-style headings are always used for levels 3+.
This option also affects Markdown cells in `ipynb` output.
`--atx-headers`
: *Deprecated synonym for `--markdown-headings=atx`.*
`--top-level-division=default`|`section`|`chapter`|`part`
: Treat top-level headings as the given division type in
LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
order is part, chapter, then section; all headings are
shifted such that the top-level heading becomes the
specified type. The default behavior is to determine the
best division type via heuristics: unless other conditions
apply, `section` is chosen. When the `documentclass`
variable is set to `report`, `book`, or `memoir` (unless the
`article` option is specified), `chapter` is implied as the
setting for this option. If `beamer` is the output format,
specifying either `chapter` or `part` will cause top-level
headings to become `\part{..}`, while second-level headings
remain as their default type.
`-N`, `--number-sections`
: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
output. By default, sections are not numbered. Sections with class
`unnumbered` will never be numbered, even if `--number-sections`
is specified.
`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
: Offset for section headings in HTML output (ignored in other
output formats). The first number is added to the section number for
top-level headings, the second for second-level headings, and so on.
So, for example, if you want the first top-level heading in your
document to be numbered "6", specify `--number-offset=5`.
If your document starts with a level-2 heading which you want to
be numbered "1.5", specify `--number-offset=1,4`.
Offsets are 0 by default. Implies `--number-sections`.
`--listings`
: Use the [`listings`] package for LaTeX code blocks. The package
does not support multi-byte encoding for source code. To handle UTF-8
you would need to use a custom template. This issue is fully
documented here: [Encoding issue with the listings package].
`-i`, `--incremental`
: Make list items in slide shows display incrementally (one by one).
The default is for lists to be displayed all at once.
`--slide-level=`*NUMBER*
: Specifies that headings with the specified level create
slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
above this level in the hierarchy are used to divide the
slide show into sections; headings below this level create
subheads within a slide. Note that content that is
not contained under slide-level headings will not appear in
the slide show. The default is to set the slide level based
on the contents of the document; see [Structuring the slide
show].
`--section-divs`
: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
and attach identifiers to the enclosing `<section>` (or `<div>`)
rather than the heading itself. See
[Heading identifiers], below.
`--email-obfuscation=none`|`javascript`|`references`
: Specify a method for obfuscating `mailto:` links in HTML documents.
`none` leaves `mailto:` links as they are. `javascript` obfuscates
them using JavaScript. `references` obfuscates them by printing their
letters as decimal or hexadecimal character references. The default
is `none`.
`--id-prefix=`*STRING*
: Specify a prefix to be added to all identifiers and internal links
in HTML and DocBook output, and to footnote numbers in Markdown
and Haddock output. This is useful for preventing duplicate
identifiers when generating fragments to be included in other pages.
`-T` *STRING*, `--title-prefix=`*STRING*
: Specify *STRING* as a prefix at the beginning of the title
that appears in the HTML header (but not in the title as it
appears at the beginning of the HTML body). Implies `--standalone`.
`-c` *URL*, `--css=`*URL*
: Link to a CSS style sheet. This option can be used repeatedly to
include multiple files. They will be included in the order specified.
A stylesheet is required for generating EPUB. If none is
provided using this option (or the `css` or `stylesheet`
metadata fields), pandoc will look for a file `epub.css` in the
user data directory (see `--data-dir`). If it is not
found there, sensible defaults will be used.
`--reference-doc=`*FILE*
: Use the specified file as a style reference in producing a
docx or ODT file.
Docx
: For best results, the reference docx should be a modified
version of a docx file produced using pandoc. The contents
of the reference docx are ignored, but its stylesheets and
document properties (including margins, page size, header,
and footer) are used in the new docx. If no reference docx
is specified on the command line, pandoc will look for a
file `reference.docx` in the user data directory (see
`--data-dir`). If this is not found either, sensible
defaults will be used.
To produce a custom `reference.docx`, first get a copy of
the default `reference.docx`: `pandoc
-o custom-reference.docx --print-default-data-file reference.docx`.
Then open `custom-reference.docx` in Word, modify the
styles as you wish, and save the file. For best
results, do not make changes to this file other than
modifying the styles used by pandoc:
Paragraph styles:
- Normal
- Body Text
- First Paragraph
- Compact
- Title
- Subtitle
- Author
- Date
- Abstract
- Bibliography
- Heading 1
- Heading 2
- Heading 3
- Heading 4
- Heading 5
- Heading 6
- Heading 7
- Heading 8
- Heading 9
- Block Text
- Footnote Text
- Definition Term
- Definition
- Caption
- Table Caption
- Image Caption
- Figure
- Captioned Figure
- TOC Heading
Character styles:
- Default Paragraph Font
- Body Text Char
- Verbatim Char
- Footnote Reference
- Hyperlink
- Section Number
Table style:
- Table
ODT
: For best results, the reference ODT should be a modified
version of an ODT produced using pandoc. The contents of
the reference ODT are ignored, but its stylesheets are used
in the new ODT. If no reference ODT is specified on the
command line, pandoc will look for a file `reference.odt` in
the user data directory (see `--data-dir`). If this is not
found either, sensible defaults will be used.
To produce a custom `reference.odt`, first get a copy of
the default `reference.odt`: `pandoc
-o custom-reference.odt --print-default-data-file reference.odt`.
Then open `custom-reference.odt` in LibreOffice, modify
the styles as you wish, and save the file.
PowerPoint
: Templates included with Microsoft PowerPoint 2013 (either with
`.pptx` or `.potx` extension) are known to work, as are most
templates derived from these.
The specific requirement is that the template should begin with
the following first four layouts:
1. Title Slide
2. Title and Content
3. Section Header
4. Two Content
All templates included with a recent version of MS PowerPoint
will fit these criteria. (You can click on `Layout` under the
`Home` menu to check.)
You can also modify the default `reference.pptx`: first run
`pandoc -o custom-reference.pptx --print-default-data-file
reference.pptx`, and then modify `custom-reference.pptx`
in MS PowerPoint (pandoc will use the first four layout
slides, as mentioned above).
`--epub-cover-image=`*FILE*
: Use the specified image as the EPUB cover. It is recommended
that the image be less than 1000px in width and height. Note that
in a Markdown source document you can also specify `cover-image`
in a YAML metadata block (see [EPUB Metadata], below).
`--epub-metadata=`*FILE*
: Look in the specified XML file for metadata for the EPUB.
The file should contain a series of [Dublin Core elements].
For example:
<dc:rights>Creative Commons</dc:rights>
<dc:language>es-AR</dc:language>
By default, pandoc will include the following metadata elements:
`<dc:title>` (from the document title), `<dc:creator>` (from the
document authors), `<dc:date>` (from the document date, which should
be in [ISO 8601 format]), `<dc:language>` (from the `lang`
variable, or, if is not set, the locale), and `<dc:identifier
id="BookId">` (a randomly generated UUID). Any of these may be
overridden by elements in the metadata file.
Note: if the source document is Markdown, a YAML metadata block
in the document can be used instead. See below under
[EPUB Metadata].
`--epub-embed-font=`*FILE*
: Embed the specified font in the EPUB. This option can be repeated
to embed multiple fonts. Wildcards can also be used: for example,
`DejaVuSans-*.ttf`. However, if you use wildcards on the command
line, be sure to escape them or put the whole filename in single quotes,
to prevent them from being interpreted by the shell. To use the
embedded fonts, you will need to add declarations like the following
to your CSS (see `--css`):
@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: normal;
src:url("DejaVuSans-Regular.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: bold;
src:url("DejaVuSans-Bold.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: normal;
src:url("DejaVuSans-Oblique.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: bold;
src:url("DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }
`--epub-chapter-level=`*NUMBER*
: Specify the heading level at which to split the EPUB into separate
"chapter" files. The default is to split into chapters at level-1
headings. This option only affects the internal composition of the
EPUB, not the way chapters and sections are displayed to users. Some
readers may be slow if the chapter files are too large, so for large
documents with few level-1 headings, one might want to use a chapter
level of 2 or 3.
`--epub-subdirectory=`*DIRNAME*
: Specify the subdirectory in the OCF container that is to hold
the EPUB-specific contents. The default is `EPUB`. To put
the EPUB contents in the top level, use an empty string.
`--ipynb-output=all|none|best`
: Determines how ipynb output cells are treated. `all` means
that all of the data formats included in the original are
preserved. `none` means that the contents of data cells
are omitted. `best` causes pandoc to try to pick the
richest data block in each output cell that is compatible
with the output format. The default is `best`.
`--pdf-engine=`*PROGRAM*
: Use the specified engine when producing PDF output.
Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
`tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
and `pdfroff`. If the engine is not in your PATH, the full
path of the engine may be specified here. If this option
is not specified, pandoc uses the following defaults
depending on the output format specified using `-t/--to`:
- `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
`tectonic`, `latexmk`)
- `-t context`: `context`
- `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
see [print-css.rocks](https://print-css.rocks) for a good
introduction to PDF generation from HTML/CSS.)
- `-t ms`: `pdfroff`
`--pdf-engine-opt=`*STRING*
: Use the given string as a command-line argument to the `pdf-engine`.
For example, to use a persistent directory `foo` for `latexmk`'s
auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
Note that no check for duplicate options is done.
[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
[Encoding issue with the listings package]:
https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
## Citation rendering {.options}
`-C`, `--citeproc`
: Process the citations in the file, replacing them with
rendered citations and adding a bibliography.
Citation processing will not take place unless bibliographic
data is supplied, either through an external file specified
using the `--bibliography` option or the `bibliography`
field in metadata, or via a `references` section in metadata
containing a list of citations in CSL YAML format with
Markdown formatting. The style is controlled by a [CSL]
stylesheet specified using the `--csl` option or the `csl`
field in metadata. (If no stylesheet is specified,
the `chicago-author-date` style will be used by default.)
The citation processing transformation may be applied before
or after filters or Lua filters (see `--filter`,
`--lua-filter`): these transformations are applied in the
order they appear on the command line. For more
information, see the section on [Citations].
`--bibliography=`*FILE*
: Set the `bibliography` field in the document's metadata to *FILE*,
overriding any value set in the metadata. If you supply
this argument multiple times, each *FILE* will be added to
bibliography. If *FILE* is a URL, it will be fetched
via HTTP. If *FILE* is not found relative to the
working directory, it will be sought in the resource path
(see `--resource-path`).
`--csl=`*FILE*
: Set the `csl` field in the document's metadata to *FILE*,
overriding any value set in the metadata. (This is equivalent to
`--metadata csl=FILE`.) If *FILE* is a URL, it will be
fetched via HTTP. If *FILE* is not found relative to the
working directory, it will be sought in the resource path
(see `--resource-path`) and finally in the `csl`
subdirectory of the pandoc user data directory.
`--citation-abbreviations=`*FILE*
: Set the `citation-abbreviations` field in the document's metadata to
*FILE*, overriding any value set in the metadata. (This is equivalent to
`--metadata citation-abbreviations=FILE`.)
If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
found relative to the working directory, it will be sought
in the resource path (see `--resource-path`) and finally in
the `csl` subdirectory of the pandoc user data directory.
`--natbib`
: Use [`natbib`] for citations in LaTeX output. This option
is not for use with the `--citeproc` option or with PDF
output. It is intended for use in producing a LaTeX file
that can be processed with [`bibtex`].
`--biblatex`
: Use [`biblatex`] for citations in LaTeX output. This option
is not for use with the `--citeproc` option or with PDF
output. It is intended for use in producing a LaTeX file
that can be processed with [`bibtex`] or [`biber`].
## Math rendering in HTML {.options}
The default is to render TeX math as far as possible using
Unicode characters. Formulas are put inside a `span` with
`class="math"`, so that they may be styled differently from the
surrounding text if needed. However, this gives acceptable
results only for basic math, usually you will want to use
`--mathjax` or another of the following options.
`--mathjax`[`=`*URL*]
: Use [MathJax] to display embedded TeX math in HTML output.
TeX math will be put between `\(...\)` (for inline math)
or `\[...\]` (for display math) and wrapped in `<span>` tags
with class `math`. Then the MathJax JavaScript will render it.
The *URL* should point to the `MathJax.js` load script.
If a *URL* is not provided, a link to the Cloudflare CDN will
be inserted.
`--mathml`
: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
`docbook5`, `jats`, `html4` and `html5`). This is the
default in `odt` output. Note that currently only Firefox
and Safari (and select e-book readers) natively support
MathML.
`--webtex`[`=`*URL*]
: Convert TeX formulas to `<img>` tags that link to an external script
that converts formulas to images. The formula will be URL-encoded
and concatenated with the URL provided. For SVG images you can for
example use `--webtex https://latex.codecogs.com/svg.latex?`.
If no URL is specified, the CodeCogs URL generating PNGs
will be used (`https://latex.codecogs.com/png.latex?`).
Note: the `--webtex` option will affect Markdown output
as well as HTML, which is useful if you're targeting a
version of Markdown without native math support.
`--katex`[`=`*URL*]
: Use [KaTeX] to display embedded TeX math in HTML output.
The *URL* is the base URL for the KaTeX library. That directory
should contain a `katex.min.js` and a `katex.min.css` file.
If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
`--gladtex`
: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
can then be processed by [GladTeX] to produce images of the typeset
formulas and an HTML file with links to these images.
So, the procedure is:
pandoc -s --gladtex input.md -o myfile.htex
gladtex -d myfile-images myfile.htex
# produces myfile.html and images in myfile-images
[MathML]: https://www.w3.org/Math/
[MathJax]: https://www.mathjax.org
[KaTeX]: https://github.com/Khan/KaTeX
[GladTeX]: https://humenda.github.io/GladTeX/
## Options for wrapper scripts {.options}
`--dump-args`
: Print information about command-line arguments to *stdout*, then exit.
This option is intended primarily for use in wrapper scripts.
The first line of output contains the name of the output file specified
with the `-o` option, or `-` (for *stdout*) if no output file was
specified. The remaining lines contain the command-line arguments,
one per line, in the order they appear. These do not include regular
pandoc options and their arguments, but do include any options appearing
after a `--` separator at the end of the line.
`--ignore-args`
: Ignore command-line arguments (for use in wrapper scripts).
Regular pandoc options are not ignored. Thus, for example,
pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
is equivalent to
pandoc -o foo.html -s
# Exit codes
If pandoc completes successfully, it will return exit code 0.
Nonzero exit codes have the following meanings:
Code Error
----- ------------------------------------
3 PandocFailOnWarningError
4 PandocAppError
5 PandocTemplateError
6 PandocOptionError
21 PandocUnknownReaderError
22 PandocUnknownWriterError
23 PandocUnsupportedExtensionError
24 PandocCiteprocError
31 PandocEpubSubdirectoryError
43 PandocPDFError
44 PandocXMLError
47 PandocPDFProgramNotFoundError
61 PandocHttpError
62 PandocShouldNeverHappenError
63 PandocSomeError
64 PandocParseError
65 PandocParsecError
66 PandocMakePDFError
67 PandocSyntaxMapError
83 PandocFilterError
91 PandocMacroLoop
92 PandocUTF8DecodingError
93 PandocIpynbDecodingError
94 PandocUnsupportedCharsetError
97 PandocCouldNotFindDataFileError
99 PandocResourceNotFound
----- ------------------------------------
# Default files
The `--defaults` option may be used to specify a package
of options. Here is a sample defaults file demonstrating all of
the fields that may be used:
``` yaml
from: markdown+emoji
# reader: may be used instead of from:
to: html5
# writer: may be used instead of to:
# leave blank for output to stdout:
output-file:
# leave blank for input from stdin, use [] for no input:
input-files:
- preface.md
- content.md
# or you may use input-file: with a single value
# Include options from the specified defaults files.
# The files will be searched for first in the working directory
# and then in the defaults subdirectory of the user data directory.
# The files are included in the same order in which they appear in
# the list. Options specified in this defaults file always have
# priority over the included ones.
defaults:
- defsA
- defsB
template: letter
standalone: true
self-contained: false
# note that structured variables may be specified:
variables:
documentclass: book
classoption:
- twosides
- draft
# metadata values specified here are parsed as literal
# string text, not markdown:
metadata:
author:
- Sam Smith
- Julie Liu
metadata-files:
- boilerplate.yaml
# or you may use metadata-file: with a single value
# Note that these take files, not their contents:
include-before-body: []
include-after-body: []
include-in-header: []
resource-path: ["."]
# turn on built-in citation processing. Note that if you need
# control over when the citeproc processing is done relative
# to other filters, you should instead use `citeproc` in the
# list of `filters` (see below).
citeproc: true
csl: ieee
bibliography:
- foobar.bib
- barbaz.json
citation-abbreviations: abbrevs.json
# Filters will be assumed to be Lua filters if they have
# the .lua extension, and json filters otherwise. But
# the filter type can also be specified explicitly, as shown.
# Filters are run in the order specified.
# To include the built-in citeproc filter, use either `citeproc`
# or `{type: citeproc}`.
filters:
- wordcount.lua
- type: json
path: foo.lua
file-scope: false
data-dir:
# ERROR, WARNING, or INFO
verbosity: INFO
log-file: log.json
# citeproc, natbib, or biblatex. This only affects LaTeX
# output. If you want to use citeproc to format citations,
# you should also set 'citeproc: true' (see above).
cite-method: citeproc
# part, chapter, section, or default:
top-level-division: chapter
abbreviations:
pdf-engine: pdflatex
pdf-engine-opts:
- "-shell-escape"
# you may also use pdf-engine-opt: with a single option
# pdf-engine-opt: "-shell-escape"
# auto, preserve, or none
wrap: auto
columns: 78
dpi: 72
extract-media: mediadir
table-of-contents: true
toc-depth: 2
number-sections: false
# a list of offsets at each heading level
number-offset: [0,0,0,0,0,0]
# toc: may also be used instead of table-of-contents:
shift-heading-level-by: 1
section-divs: true
identifier-prefix: foo
title-prefix: ""
strip-empty-paragraphs: true
# lf, crlf, or native
eol: lf
strip-comments: false
indented-code-classes: []
ascii: true
default-image-extension: ".jpg"
# either a style name of a style definition file:
highlight-style: pygments
syntax-definitions:
- c.xml
# or you may use syntax-definition: with a single value
listings: false
reference-doc: myref.docx
# method is plain, webtex, gladtex, mathml, mathjax, katex
# you may specify a url with webtex, mathjax, katex
html-math-method:
method: mathjax
url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
# none, references, or javascript
email-obfuscation: javascript
tab-stop: 8
preserve-tabs: true
incremental: false
slide-level: 2
epub-subdirectory: EPUB
epub-metadata: meta.xml
epub-fonts:
- foobar.otf
epub-chapter-level: 1
epub-cover-image: cover.jpg
reference-links: true
# block, section, or document
reference-location: block
markdown-headings: setext
# accept, reject, or all
track-changes: accept
html-q-tags: false
css:
- site.css
# none, all, or best
ipynb-output: best
# A list of two-element lists
request-headers:
- ["User-Agent", "Mozilla/5.0"]
fail-if-warnings: false
dump-args: false
ignore-args: false
trace: false
```
Fields that are omitted will just have their regular
default values. So a defaults file can be as simple as
one line:
``` yaml
verbosity: INFO
```
In fields that expect a file path (or list of file paths), the
following syntax may be used to interpolate environment variables:
``` yaml
csl: ${HOME}/mycsldir/special.csl
```
`${USERDATA}` may also be used; this will always resolve to the
user data directory that is current when the defaults file is
parsed, regardless of the setting of the environment
variable `USERDATA`.
`${.}` will resolve to the directory containing the default
file itself. This allows you to refer to resources contained
in that directory:
``` yaml
epub-cover-image: ${.}/cover.jpg
epub-metadata: ${.}/meta.xml
resource-path:
- . # the working directory from which pandoc is run
- ${.}/images # the images subdirectory of the directory
# containing this defaults file
```
This environment variable interpolation syntax *only* works in
fields that expect file paths.
Default files can be placed in the `defaults` subdirectory of
the user data directory and used from any directory. For
example, one could create a file specifying defaults for writing
letters, save it as `letter.yaml` in the `defaults` subdirectory
of the user data directory, and then invoke these defaults
from any directory using `pandoc --defaults letter`
or `pandoc -dletter`.
When multiple defaults are used, their contents will be combined.
Note that, where command-line arguments may be repeated
(`--metadata-file`, `--css`, `--include-in-header`,
`--include-before-body`, `--include-after-body`, `--variable`,
`--metadata`, `--syntax-definition`), the values specified on
the command line will combine with values specified in the
defaults file, rather than replacing them.
# Templates
When the `-s/--standalone` option is used, pandoc uses a template to
add header and footer material that is needed for a self-standing
document. To see the default template that is used, just type
pandoc -D *FORMAT*
where *FORMAT* is the name of the output format. A custom template
can be specified using the `--template` option. You can also override
the system default templates for a given output format *FORMAT*
by putting a file `templates/default.*FORMAT*` in the user data
directory (see `--data-dir`, above). *Exceptions:*
- For `odt` output, customize the `default.opendocument`
template.
- For `pdf` output, customize the `default.latex` template
(or the `default.context` template, if you use `-t context`,
or the `default.ms` template, if you use `-t ms`, or the
`default.html` template, if you use `-t html`).
- `docx` and `pptx` have no template (however, you can use
`--reference-doc` to customize the output).
Templates contain *variables*, which allow for the inclusion of
arbitrary information at any point in the file. They may be set at the
command line using the `-V/--variable` option. If a variable is not set,
pandoc will look for the key in the document's metadata, which can be set
using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
or with the `-M/--metadata` option. In addition, some variables
are given default values by pandoc. See [Variables] below for
a list of variables used in pandoc's default templates.
If you use custom templates, you may need to revise them as pandoc
changes. We recommend tracking the changes in the default templates,
and modifying your custom templates accordingly. An easy way to do this
is to fork the [pandoc-templates] repository and merge in
changes after each pandoc release.
[pandoc-templates]: https://github.com/jgm/pandoc-templates
## Template syntax
### Comments
Anything between the sequence `$--` and the end of the
line will be treated as a comment and omitted from the output.
### Delimiters
To mark variables and control structures in the template,
either `$`...`$` or `${`...`}` may be used as delimiters.
The styles may also be mixed in the same template, but the
opening and closing delimiter must match in each case. The
opening delimiter may be followed by one or more spaces
or tabs, which will be ignored. The closing delimiter may
be followed by one or more spaces or tabs, which will be
ignored.
To include a literal `$` in the document, use `$$`.
### Interpolated variables
A slot for an interpolated variable is a variable name surrounded
by matched delimiters. Variable names must begin with a letter
and can contain letters, numbers, `_`, `-`, and `.`. The
keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
not be used as variable names. Examples:
```
$foo$
$foo.bar.baz$
$foo_bar.baz-bim$
$ foo $
${foo}
${foo.bar.baz}
${foo_bar.baz-bim}
${ foo }
```
Variable names with periods are used to get at structured
variable values. So, for example, `employee.salary` will return the
value of the `salary` field of the object that is the value of
the `employee` field.
- If the value of the variable is simple value, it will be
rendered verbatim. (Note that no escaping is done;
the assumption is that the calling program will escape
the strings appropriately for the output format.)
- If the value is a list, the values will be concatenated.
- If the value is a map, the string `true` will be rendered.
- Every other value will be rendered as the empty string.
### Conditionals
A conditional begins with `if(variable)` (enclosed in
matched delimiters) and ends with `endif` (enclosed in matched
delimiters). It may optionally contain an `else` (enclosed in
matched delimiters). The `if` section is used if
`variable` has a non-empty value, otherwise the `else`
section is used (if present). Examples:
```
$if(foo)$bar$endif$
$if(foo)$
$foo$
$endif$
$if(foo)$
part one
$else$
part two
$endif$
${if(foo)}bar${endif}
${if(foo)}
${foo}
${endif}
${if(foo)}
${ foo.bar }
${else}
no foo!
${endif}
```
The keyword `elseif` may be used to simplify complex nested
conditionals:
```
$if(foo)$
XXX
$elseif(bar)$
YYY
$else$
ZZZ
$endif$
```
### For loops
A for loop begins with `for(variable)` (enclosed in
matched delimiters) and ends with `endfor` (enclosed in matched
delimiters.
- If `variable` is an array, the material inside the loop will
be evaluated repeatedly, with `variable` being set to each
value of the array in turn, and concatenated.
- If `variable` is a map, the material inside will be set to
the map.
- If the value of the associated variable is not an array or
a map, a single iteration will be performed on its value.
Examples:
```
$for(foo)$$foo$$sep$, $endfor$
$for(foo)$
- $foo.last$, $foo.first$
$endfor$
${ for(foo.bar) }
- ${ foo.bar.last }, ${ foo.bar.first }
${ endfor }
$for(mymap)$
$it.name$: $it.office$
$endfor$
```
You may optionally specify a separator between consecutive
values using `sep` (enclosed in matched delimiters). The
material between `sep` and the `endfor` is the separator.
```
${ for(foo) }${ foo }${ sep }, ${ endfor }
```
Instead of using `variable` inside the loop, the special
anaphoric keyword `it` may be used.
```
${ for(foo.bar) }
- ${ it.last }, ${ it.first }
${ endfor }
```
### Partials
Partials (subtemplates stored in different files) may be
included by using the name of the partial, followed
by `()`, for example:
```
${ styles() }
```
Partials will be sought in the directory containing
the main template. The file name will be assumed to
have the same extension as the main template if it
lacks an extension. When calling the partial, the
full name including file extension can also be used:
```
${ styles.html() }
```
(If a partial is not found in the directory of the
template and the template path is given as a relative
path, it will also be sought in the `templates`
subdirectory of the user data directory.)
Partials may optionally be applied to variables using
a colon:
```
${ date:fancy() }
${ articles:bibentry() }
```
If `articles` is an array, this will iterate over its
values, applying the partial `bibentry()` to each one. So the
second example above is equivalent to
```
${ for(articles) }
${ it:bibentry() }
${ endfor }
```
Note that the anaphoric keyword `it` must be used when
iterating over partials. In the above examples,
the `bibentry` partial should contain `it.title`
(and so on) instead of `articles.title`.
Final newlines are omitted from included partials.
Partials may include other partials.
A separator between values of an array may be specified
in square brackets, immediately after the variable name
or partial:
```
${months[, ]}$
${articles:bibentry()[; ]$
```
The separator in this case is literal and (unlike with `sep`
in an explicit `for` loop) cannot contain interpolated
variables or other template directives.
### Nesting
To ensure that content is "nested," that is, subsequent lines
indented, use the `^` directive:
```
$item.number$ $^$$item.description$ ($item.price$)
```
In this example, if `item.description` has multiple lines,
they will all be indented to line up with the first line:
```
00123 A fine bottle of 18-year old
Oban whiskey. ($148)
```
To nest multiple lines to the same level, align them
with the `^` directive in the template. For example:
```
$item.number$ $^$$item.description$ ($item.price$)
(Available til $item.sellby$.)
```
will produce
```
00123 A fine bottle of 18-year old
Oban whiskey. ($148)
(Available til March 30, 2020.)
```
If a variable occurs by itself on a line, preceded by whitespace
and not followed by further text or directives on the same line,
and the variable's value contains multiple lines, it will be
nested automatically.
### Breakable spaces
Normally, spaces in the template itself (as opposed to values of
the interpolated variables) are not breakable, but they can be
made breakable in part of the template by using the `~` keyword
(ended with another `~`).
```
$~$This long line may break if the document is rendered
with a short line length.$~$
```
### Pipes
A pipe transforms the value of a variable or partial. Pipes are
specified using a slash (`/`) between the variable name (or partial)
and the pipe name. Example:
```
$for(name)$
$name/uppercase$
$endfor$
$for(metadata/pairs)$
- $it.key$: $it.value$
$endfor$
$employee:name()/uppercase$
```
Pipes may be chained:
```
$for(employees/pairs)$
$it.key/alpha/uppercase$. $it.name$
$endfor$
```
Some pipes take parameters:
```
|----------------------|------------|
$for(employee)$
$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
$endfor$
|----------------------|------------|
```
Currently the following pipes are predefined:
- `pairs`: Converts a map or array to an array of maps,
each with `key` and `value` fields. If the original
value was an array, the `key` will be the array index,
starting with 1.
- `uppercase`: Converts text to uppercase.
- `lowercase`: Converts text to lowercase.
- `length`: Returns the length of the value: number
of characters for a textual value, number of elements
for a map or array.
- `reverse`: Reverses a textual value or array,
and has no effect on other values.
- `first`: Returns the first value of an array, if
applied to a non-empty array; otherwise returns
the original value.
- `last`: Returns the last value of an array, if
applied to a non-empty array; otherwise returns
the original value.
- `rest`: Returns all but the first value of an array, if
applied to a non-empty array; otherwise returns
the original value.
- `allbutlast`: Returns all but the last value of an array, if
applied to a non-empty array; otherwise returns
the original value.
- `chomp`: Removes trailing newlines (and breakable space).
- `nowrap`: Disables line wrapping on breakable spaces.
- `alpha`: Converts textual values that can be
read as an integer into lowercase alphabetic
characters `a..z` (mod 26). This can be used to get lettered
enumeration from array indices. To get uppercase
letters, chain with `uppercase`.
- `roman`: Converts textual values that can be
read as an integer into lowercase roman numerials.
This can be used to get lettered enumeration from array indices.
To get uppercase roman, chain with `uppercase`.
- `left n "leftborder" "rightborder"`: Renders a textual value
in a block of width `n`, aligned to the left, with an optional
left and right border. Has no effect on other values. This
can be used to align material in tables. Widths are positive
integers indicating the number of characters. Borders
are strings inside double quotes; literal `"` and `\` characters
must be backslash-escaped.
- `right n "leftborder" "rightborder"`: Renders a textual value
in a block of width `n`, aligned to the right, and has no
effect on other values.
- `center n "leftborder" "rightborder"`: Renders a textual
value in a block of width `n`, aligned to the center, and has
no effect on other values.
## Variables
### Metadata variables
`title`, `author`, `date`
: allow identification of basic aspects of the document. Included
in PDF metadata through LaTeX and ConTeXt. These can be set
through a [pandoc title block][Extension: `pandoc_title_block`],
which allows for multiple authors, or through a
[YAML metadata block][Extension: `yaml_metadata_block`]:
---
author:
- Aristotle
- Peter Abelard
...
Note that if you just want to set PDF or HTML metadata, without
including a title block in the document itself, you can
set the `title-meta`, `author-meta`, and `date-meta`
variables. (By default these are set automatically, based
on `title`, `author`, and `date`.) The page title in HTML
is set by `pagetitle`, which is equal to `title` by default.
`subtitle`
: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
documents
`abstract`
: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
documents
`keywords`
: list of keywords to be included in HTML, PDF, ODT, pptx, docx
and AsciiDoc metadata; repeat as for `author`, above
`subject`
: document subject, included in ODT, PDF, docx and pptx metadata
`description`
: document description, included in ODT, docx and pptx metadata. Some
applications show this as `Comments` metadata.
`category`
: document category, included in docx and pptx metadata
Additionally,
any root-level string metadata, not included in ODT, docx
or pptx metadata is added as a *custom property*.
The following [YAML] metadata block for instance:
---
title: 'This is the title'
subtitle: "This is the subtitle"
author:
- Author One
- Author Two
description: |
This is a long
description.
It consists of two paragraphs
...
will include `title`, `author` and `description` as standard document
properties and `subtitle` as a custom property when converting to docx,
ODT or pptx.
### Language variables
`lang`
: identifies the main language of the document using IETF language
tags (following the [BCP 47] standard), such as `en` or `en-GB`.
The [Language subtag lookup] tool can look up or verify these tags.
This affects most formats, and controls hyphenation in PDF output
when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
Use native pandoc [Divs and Spans] with the `lang` attribute to
switch the language:
---
lang: en-GB
...
Text in the main document language (British English).
::: {lang=fr-CA}
> Cette citation est écrite en français canadien.
:::
More text in English. ['Zitat auf Deutsch.']{lang=de}
`dir`
: the base script direction, either `rtl` (right-to-left)
or `ltr` (left-to-right).
For bidirectional documents, native pandoc `span`s and
`div`s with the `dir` attribute (value `rtl` or `ltr`) can
be used to override the base direction in some output
formats. This may not always be necessary if the final
renderer (e.g. the browser, when generating HTML) supports
the [Unicode Bidirectional Algorithm].
When using LaTeX for bidirectional documents, only the
`xelatex` engine is fully supported (use
`--pdf-engine=xelatex`).
[BCP 47]: https://tools.ietf.org/html/bcp47
[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
[Language subtag lookup]: https://r12a.github.io/app-subtags/
### Variables for HTML
`document-css`
: Enables inclusion of most of the [CSS] in the `styles.html`
[partial](#partials) (have a look with
`pandoc --print-default-data-file=templates/styles.html`).
Unless you use [`--css`](#option--css), this variable
is set to `true` by default. You can disable it with
e.g. `pandoc -M document-css=false`.
`mainfont`
: sets the CSS `font-family` property on the `html` element.
`fontsize`
: sets the base CSS `font-size`, which you'd usually set
to e.g. `20px`, but it also accepts `pt`
(12pt = 16px in most browsers).
`fontcolor`
: sets the CSS `color` property on the `html` element.
`linkcolor`
: sets the CSS `color` property on all links.
`monofont`
: sets the CSS `font-family` property on `code` elements.
`monobackgroundcolor`
: sets the CSS `background-color` property on `code` elements
and adds extra padding.
`linestretch`
: sets the CSS `line-height` property on the `html` element,
which is preferred to be unitless.
`backgroundcolor`
: sets the CSS `background-color` property on the `html` element.
`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: sets the corresponding CSS `padding` properties on the `body` element.
To override or extend some [CSS] for just one document, include for example:
---
header-includes: |
<style>
blockquote {
font-style: italic;
}
tr.even {
background-color: #f0f0f0;
}
td, th {
padding: 0.5em 2em 0.5em 0.5em;
}
tbody {
border-bottom: none;
}
</style>
---
[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
### Variables for HTML math
`classoption`
: when using [KaTeX](#option--katex), you can render display
math equations flush left using [YAML metadata](#layout) or with
`-M classoption=fleqn`.
### Variables for HTML slides
These affect HTML output when [producing slide shows with pandoc].
All [reveal.js configuration options] are available as variables.
To turn off boolean flags that default to true in reveal.js, use `0`.
`revealjs-url`
: base URL for reveal.js documents (defaults to
`https://unpkg.com/reveal.js@^4/`)
`s5-url`
: base URL for S5 documents (defaults to `s5/default`)
`slidy-url`
: base URL for Slidy documents (defaults to
`https://www.w3.org/Talks/Tools/Slidy2`)
`slideous-url`
: base URL for Slideous documents (defaults to `slideous`)
`title-slide-attributes`
: additional attributes for the title slide of reveal.js slide shows.
See [background in reveal.js and beamer] for an example.
[reveal.js configuration options]: https://revealjs.com/config/
### Variables for Beamer slides
These variables change the appearance of PDF slides using [`beamer`].
`aspectratio`
: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
`1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
`32` for 3:2)
`beamerarticle`
: produce an article from Beamer slides
`beameroption`
: add extra beamer option with `\setbeameroption{}`
`institute`
: author affiliations: can be a list when there are multiple authors
`logo`
: logo image for slides
`navigation`
: controls navigation symbols (default is `empty` for no navigation
symbols; other valid values are `frame`, `vertical`, and `horizontal`)
`section-titles`
: enables "title pages" for new sections (default is true)
`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
: beamer themes
`themeoptions`
: options for LaTeX beamer themes (a list).
`titlegraphic`
: image for title slide
### Variables for PowerPoint
These variables control the visual aspects of a slide show that
are not easily controlled via templates.
`monofont`
: font to use for code.
### Variables for LaTeX
Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
#### Layout
`block-headings`
: make `\paragraph` and `\subparagraph` (fourth- and
fifth-level headings, or fifth- and sixth-level with book
classes) free-standing rather than run-in; requires further
formatting to distinguish from `\subsubsection` (third- or
fourth-level headings). Instead of using this option,
[KOMA-Script] can adjust headings more extensively:
---
documentclass: scrartcl
header-includes: |
\RedeclareSectionCommand[
beforeskip=-10pt plus -2pt minus -1pt,
afterskip=1sp plus -1sp minus 1sp,
font=\normalfont\itshape]{paragraph}
\RedeclareSectionCommand[
beforeskip=-10pt plus -2pt minus -1pt,
afterskip=1sp plus -1sp minus 1sp,
font=\normalfont\scshape,
indent=0pt]{subparagraph}
...
`classoption`
: option for document class, e.g. `oneside`; repeat for multiple options:
---
classoption:
- twocolumn
- landscape
...
`documentclass`
: document class: usually one of the standard classes,
[`article`], [`book`], and [`report`]; the [KOMA-Script]
equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
default to smaller margins; or [`memoir`]
`geometry`
: option for [`geometry`] package, e.g. `margin=1in`;
repeat for multiple options:
---
geometry:
- top=30mm
- left=20mm
- heightrounded
...
`hyperrefoptions`
: option for [`hyperref`] package, e.g. `linktoc=all`;
repeat for multiple options:
---
hyperrefoptions:
- linktoc=all
- pdfwindowui
- pdfpagemode=FullScreen
...
`indent`
: if true, pandoc will use document class settings for
indentation (the default LaTeX template otherwise removes
indentation and adds space between paragraphs)
`linestretch`
: adjusts line spacing using the [`setspace`]
package, e.g. `1.25`, `1.5`
`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: sets margins if `geometry` is not used (otherwise `geometry`
overrides these)
`pagestyle`
: control `\pagestyle{}`: the default article class
supports `plain` (default), `empty` (no running heads or page numbers),
and `headings` (section titles in running heads)
`papersize`
: paper size, e.g. `letter`, `a4`
`secnumdepth`
: numbering depth for sections (with `--number-sections` option
or `numbersections` variable)
#### Fonts
`fontenc`
: allows font encoding to be specified through `fontenc` package (with
`pdflatex`); default is `T1` (see [LaTeX font encodings guide])
`fontfamily`
: font package for use with `pdflatex`:
[TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
The default is [Latin Modern][`lm`].
`fontfamilyoptions`
: options for package used as `fontfamily`; repeat for multiple options.
For example, to use the Libertine font with proportional lowercase
(old-style) figures through the [`libertinus`] package:
---
fontfamily: libertinus
fontfamilyoptions:
- osf
- p
...
`fontsize`
: font size for body text. The standard classes allow 10pt, 11pt, and
12pt. To use another size, set `documentclass` to one of
the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
: font families for use with `xelatex` or
`lualatex`: take the name of any system font, using the
[`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
`CJKmainfont` in `xelatex` and `lualatex`. Allow for any
choices available through [`fontspec`]; repeat for multiple
options. For example, to use the [TeX Gyre] version of
Palatino with lowercase figures:
---
mainfont: TeX Gyre Pagella
mainfontoptions:
- Numbers=Lowercase
- Numbers=Proportional
...
`microtypeoptions`
: options to pass to the microtype package
#### Links
`colorlinks`
: add color to link text; automatically enabled if any of
`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
: color for internal links, external links, citation links, linked
URLs, and links in table of contents, respectively: uses options
allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
`x11names` lists
`links-as-notes`
: causes links to be printed as footnotes
#### Front matter
`lof`, `lot`
: include list of figures, list of tables
`thanks`
: contents of acknowledgments footnote after document title
`toc`
: include table of contents (can also be set using
`--toc/--table-of-contents`)
`toc-depth`
: level of section to include in table of contents
#### BibLaTeX Bibliographies
These variables function when using BibLaTeX for [citation rendering].
`biblatexoptions`
: list of options for biblatex
`biblio-style`
: bibliography style, when used with `--natbib` and `--biblatex`.
`biblio-title`
: bibliography title, when used with `--natbib` and `--biblatex`.
`bibliography`
: bibliography to use for resolving references
`natbiboptions`
: list of options for natbib
[KOMA-Script]: https://ctan.org/pkg/koma-script
[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
[`article`]: https://ctan.org/pkg/article
[`book`]: https://ctan.org/pkg/book
[`libertinus`]: https://ctan.org/pkg/libertinus
[`memoir`]: https://ctan.org/pkg/memoir
[`report`]: https://ctan.org/pkg/report
### Variables for ConTeXt
Pandoc uses these variables when [creating a PDF] with ConTeXt.
`fontsize`
: font size for body text (e.g. `10pt`, `12pt`)
`headertext`, `footertext`
: text to be placed in running header or footer (see [ConTeXt Headers and
Footers]); repeat up to four times for different placement
`indenting`
: controls indentation of paragraphs, e.g. `yes,small,next` (see
[ConTeXt Indentation]); repeat for multiple options
`interlinespace`
: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
repeat for multiple options
`layout`
: options for page margins and text arrangement (see [ConTeXt Layout]);
repeat for multiple options
`linkcolor`, `contrastcolor`
: color for links outside and inside a page, e.g. `red`, `blue` (see
[ConTeXt Color])
`linkstyle`
: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
`type`, `cap`, `small`
`lof`, `lot`
: include list of figures, list of tables
`mainfont`, `sansfont`, `monofont`, `mathfont`
: font families: take the name of any system font (see
[ConTeXt Font Switching])
`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: sets margins, if `layout` is not used (otherwise `layout`
overrides these)
`pagenumbering`
: page number style and location (using [`setuppagenumbering`]);
repeat for multiple options
`papersize`
: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
repeat for multiple options
`pdfa`
: adds to the preamble the setup necessary to generate PDF/A
of the type specified, e.g. `1a:2005`, `2a`. If no type is
specified (i.e. the value is set to True, by e.g.
`--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
`1b:2005` will be used as default, for reasons of backwards
compatibility. Using `--variable=pdfa` without specified value
is not supported. To successfully generate PDF/A the required
ICC color profiles have to be available and the content and all
included files (such as images) have to be standard conforming.
The ICC profiles and output intent may be specified using the
variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
PDFA] for more details.
`pdfaiccprofile`
: when used in conjunction with `pdfa`, specifies the ICC profile to use
in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
used as default. May be repeated to include multiple profiles. Note that
the profiles have to be available on the system. They can be obtained
from [ConTeXt ICC Profiles].
`pdfaintent`
: when used in conjunction with `pdfa`, specifies the output intent for
the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
If left unspecified, `sRGB IEC61966-2.1` is used as default.
`toc`
: include table of contents (can also be set using
`--toc/--table-of-contents`)
`whitespace`
: spacing between paragraphs, e.g. `none`, `small` (using
[`setupwhitespace`])
`includesource`
: include all source documents as file attachments in the PDF file
[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
[ConTeXt Color]: https://wiki.contextgarden.net/Color
[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
### Variables for `wkhtmltopdf`
Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
The `--css` option also affects the output.
`footer-html`, `header-html`
: add information to the header and footer
`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
: set the page margins
`papersize`
: sets the PDF paper size
### Variables for man pages
`adjusting`
: adjusts text to left (`l`), right (`r`), center (`c`),
or both (`b`) margins
`footer`
: footer in man pages
`header`
: header in man pages
`hyphenate`
: if `true` (the default), hyphenation will be used
`section`
: section number in man pages
### Variables for ms
`fontfamily`
: font family (e.g. `T` or `P`)
`indent`
: paragraph indent (e.g. `2m`)
`lineheight`
: line height (e.g. `12p`)
`pointsize`
: point size (e.g. `10p`)
### Variables set automatically
Pandoc sets these variables automatically in response to [options] or
document contents; users can also modify them. These vary depending
on the output format, and include the following:
`body`
: body of document
`date-meta`
: the `date` variable converted to ISO 8601 YYYY-MM-DD,
included in all HTML based formats (dzslides, epub,
html, html4, html5, revealjs, s5, slideous, slidy).
The recognized formats for `date` are: `mm/dd/yyyy`,
`mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
(e.g. either `02 Apr 2018` or `02 April 2018`),
`MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
`yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
`header-includes`
: contents specified by `-H/--include-in-header` (may have multiple
values)
`include-before`
: contents specified by `-B/--include-before-body` (may have
multiple values)
`include-after`
: contents specified by `-A/--include-after-body` (may have
multiple values)
`meta-json`
: JSON representation of all of the document's metadata. Field
values are transformed to the selected output format.
`numbersections`
: non-null value if `-N/--number-sections` was specified
`sourcefile`, `outputfile`
: source and destination filenames, as given on the command line.
`sourcefile` can also be a list if input comes from multiple files,
or empty if input is from stdin. You can use the following snippet in
your template to distinguish them:
$if(sourcefile)$
$for(sourcefile)$
$sourcefile$
$endfor$
$else$
(stdin)
$endif$
Similarly, `outputfile` can be `-` if output goes to the terminal.
If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
`curdir`
: working directory from which pandoc is run.
`toc`
: non-null value if `--toc/--table-of-contents` was specified
`toc-title`
: title of table of contents (works only with EPUB,
HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
[pandoc-templates]: https://github.com/jgm/pandoc-templates
# Extensions
The behavior of some of the readers and writers can be adjusted by
enabling or disabling various extensions.
An extension can be enabled by adding `+EXTENSION`
to the format name and disabled by adding `-EXTENSION`. For example,
`--from markdown_strict+footnotes` is strict Markdown with footnotes
enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
Markdown without footnotes or pipe tables.
The markdown reader and writer make by far the most use of extensions.
Extensions only used by them are therefore covered in the
section [Pandoc's Markdown] below (See [Markdown variants] for
`commonmark` and `gfm`.) In the following, extensions that also work
for other formats are covered.
Note that markdown extensions added to the `ipynb` format
affect Markdown cells in Jupyter notebooks (as do command-line
options like `--atx-headers`).
## Typography
#### Extension: `smart` ####
Interpret straight quotes as curly quotes, `---` as em-dashes,
`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
inserted after certain abbreviations, such as "Mr."
This extension can be enabled/disabled for the following formats:
input formats
: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
output formats
: `markdown`, `latex`, `context`, `rst`
enabled by default in
: `markdown`, `latex`, `context` (both input and output)
Note: If you are *writing* Markdown, then the `smart` extension
has the reverse effect: what would have been curly quotes comes
out straight.
In LaTeX, `smart` means to use the standard TeX ligatures
for quotation marks (` `` ` and ` '' ` for double quotes,
`` ` `` and `` ' `` for single quotes) and dashes (`--` for
en-dash and `---` for em-dash). If `smart` is disabled,
then in reading LaTeX pandoc will parse these characters
literally. In writing LaTeX, enabling `smart` tells pandoc
to use the ligatures when possible; if `smart` is disabled
pandoc will use unicode quotation mark and dash characters.
## Headings and sections
#### Extension: `auto_identifiers` ####
A heading without an explicitly specified identifier will be
automatically assigned a unique identifier based on the heading text.
This extension can be enabled/disabled for the following formats:
input formats
: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
output formats
: `markdown`, `muse`
enabled by default in
: `markdown`, `muse`
The default algorithm used to derive the identifier from the
heading text is:
- Remove all formatting, links, etc.
- Remove all footnotes.
- Remove all non-alphanumeric characters,
except underscores, hyphens, and periods.
- Replace all spaces and newlines with hyphens.
- Convert all alphabetic characters to lowercase.
- Remove everything up to the first letter (identifiers may
not begin with a number or punctuation mark).
- If nothing is left after this, use the identifier `section`.
Thus, for example,
Heading Identifier
------------------------------- ----------------------------
`Heading identifiers in HTML` `heading-identifiers-in-html`
`Maître d'hôtel` `maître-dhôtel`
`*Dogs*?--in *my* house?` `dogs--in-my-house`
`[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
`3. Applications` `applications`
`33` `section`
These rules should, in most cases, allow one to determine the identifier
from the heading text. The exception is when several headings have the
same text; in this case, the first will get an identifier as described
above; the second will get the same identifier with `-1` appended; the
third with `-2`; and so on.
(However, a different algorithm is used if
`gfm_auto_identifiers` is enabled; see below.)
These identifiers are used to provide link targets in the table of
contents generated by the `--toc|--table-of-contents` option. They
also make it easy to provide links from one section of a document to
another. A link to this section, for example, might look like this:
See the section on
[heading identifiers](#heading-identifiers-in-html-latex-and-context).
Note, however, that this method of providing links to sections works
only in HTML, LaTeX, and ConTeXt formats.
If the `--section-divs` option is specified, then each section will
be wrapped in a `section` (or a `div`, if `html4` was specified),
and the identifier will be attached to the enclosing `<section>`
(or `<div>`) tag rather than the heading itself. This allows entire
sections to be manipulated using JavaScript or treated differently in
CSS.
#### Extension: `ascii_identifiers` ####
Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
Accents are stripped off of accented Latin letters, and non-Latin
letters are omitted.
#### Extension: `gfm_auto_identifiers` ####
Changes the algorithm used by `auto_identifiers` to conform to
GitHub's method. Spaces are converted to dashes (`-`),
uppercase characters to lowercase characters, and punctuation
characters other than `-` and `_` are removed.
Emojis are replaced by their names.
## Math Input
The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
are described in the section about Pandoc's Markdown.
However, they can also be used with HTML input. This is handy for
reading web pages formatted using MathJax, for example.
## Raw HTML/TeX
The following extensions are described in more detail in
their respective sections of [Pandoc's Markdown]:
- [`raw_html`](#extension-raw_html) allows HTML elements which
are not representable in pandoc's AST to be parsed as raw HTML.
By default, this is disabled for HTML input.
- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
to be included in a document. This extension can be enabled/disabled
for the following formats (in addition to `markdown`):
input formats
: `latex`, `textile`, `html` (environments, `\ref`, and
`\eqref` only), `ipynb`
output formats
: `textile`, `commonmark`
Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
only raw TeX in markdown cells, but data with mime type
`text/html` in output cells. Since the `ipynb` reader attempts
to preserve the richest possible outputs when several options
are given, you will get best results if you disable `raw_html`
and `raw_tex` when converting to formats like `docx` which don't
allow raw `html` or `tex`.
- [`native_divs`](#extension-native_divs) causes HTML `div`
elements to be parsed as native pandoc Div blocks.
If you want them to be parsed as raw HTML, use
`-f html-native_divs+raw_html`.
- [`native_spans`](#extension-native_spans) causes HTML `span`
elements to be parsed as native pandoc Span inlines.
If you want them to be parsed as raw HTML, use
`-f html-native_spans+raw_html`. If you want to drop all
`div`s and `span`s when converting HTML to Markdown, you
can use `pandoc -f html-native_divs-native_spans -t markdown`.
## Literate Haskell support
#### Extension: `literate_haskell` ####
Treat the document as literate Haskell source.
This extension can be enabled/disabled for the following formats:
input formats
: `markdown`, `rst`, `latex`
output formats
: `markdown`, `rst`, `latex`, `html`
If you append `+lhs` (or `+literate_haskell`) to one of the formats
above, pandoc will treat the document as literate Haskell source.
This means that
- In Markdown input, "bird track" sections will be parsed as Haskell
code rather than block quotations. Text between `\begin{code}`
and `\end{code}` will also be treated as Haskell code. For
ATX-style headings the character '=' will be used instead of '#'.
- In Markdown output, code blocks with classes `haskell` and `literate`
will be rendered using bird tracks, and block quotations will be
indented one space, so they will not be treated as Haskell code.
In addition, headings will be rendered setext-style (with underlines)
rather than ATX-style (with '#' characters). (This is because ghc
treats '#' characters in column 1 as introducing line numbers.)
- In restructured text input, "bird track" sections will be parsed
as Haskell code.
- In restructured text output, code blocks with class `haskell` will
be rendered using bird tracks.
- In LaTeX input, text in `code` environments will be parsed as
Haskell code.
- In LaTeX output, code blocks with class `haskell` will be rendered
inside `code` environments.
- In HTML output, code blocks with class `haskell` will be rendered
with class `literatehaskell` and bird tracks.
Examples:
pandoc -f markdown+lhs -t html
reads literate Haskell source formatted with Markdown conventions and writes
ordinary HTML (without bird tracks).
pandoc -f markdown+lhs -t html+lhs
writes HTML with the Haskell code in bird tracks, so it can be copied
and pasted as literate Haskell source.
Note that GHC expects the bird tracks in the first column, so indented
literate code blocks (e.g. inside an itemized environment) will not be
picked up by the Haskell compiler.
## Other extensions
#### Extension: `empty_paragraphs` ####
Allows empty paragraphs. By default empty paragraphs are
omitted.
This extension can be enabled/disabled for the following formats:
input formats
: `docx`, `html`
output formats
: `docx`, `odt`, `opendocument`, `html`
#### Extension: `native_numbering` ####
Enables native numbering of figures and tables. Enumeration
starts at 1.
This extension can be enabled/disabled for the following formats:
output formats
: `odt`, `opendocument`
#### Extension: `xrefs_name` ####
Links to headings, figures and tables inside the document are
substituted with cross-references that will use the name or caption
of the referenced item. The original link text is replaced once
the generated document is refreshed. This extension can be combined
with `xrefs_number` in which case numbers will appear before the
name.
Text in cross-references is only made consistent with the referenced
item once the document has been refreshed.
This extension can be enabled/disabled for the following formats:
output formats
: `odt`, `opendocument`
#### Extension: `xrefs_number` ####
Links to headings, figures and tables inside the document are
substituted with cross-references that will use the number
of the referenced item. The original link text is discarded.
This extension can be combined with `xrefs_name` in which case
the name or caption numbers will appear after the number.
For the `xrefs_number` to be useful heading numbers must be enabled
in the generated document, also table and figure captions must be enabled
using for example the `native_numbering` extension.
Numbers in cross-references are only visible in the final document once
it has been refreshed.
This extension can be enabled/disabled for the following formats:
output formats
: `odt`, `opendocument`
#### Extension: `styles` #### {#ext-styles}
When converting from docx, read all docx styles as divs (for
paragraph styles) and spans (for character styles) regardless
of whether pandoc understands the meaning of these styles.
This can be used with [docx custom styles](#custom-styles).
Disabled by default.
input formats
: `docx`
#### Extension: `amuse` ####
In the `muse` input format, this enables Text::Amuse
extensions to Emacs Muse markup.
#### Extension: `raw_markdown` ####
In the `ipynb` input format, this causes Markdown cells
to be included as raw Markdown blocks (allowing lossless
round-tripping) rather than being parsed. Use this only
when you are targeting `ipynb` or a markdown-based
output format.
#### Extension: `citations` {#org-citations}
Some aspects of [Pandoc's Markdown citation syntax](#citations)
are also accepted in `org` input.
#### Extension: `element_citations` ####
In the `jats` output formats, this causes reference items to
be replaced with `<element-citation>` elements. These
elements are not influenced by CSL styles, but all information
on the item is included in tags.
#### Extension: `ntb` ####
In the `context` output format this enables the use of [Natural Tables
(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
Natural tables allow more fine-grained global customization but come
at a performance penalty compared to extreme tables.
# Pandoc's Markdown
Pandoc understands an extended and slightly revised version of
John Gruber's [Markdown] syntax. This document explains the syntax,
noting differences from standard Markdown. Except where noted, these
differences can be suppressed by using the `markdown_strict` format instead
of `markdown`. Extensions can be enabled or disabled to specify the
behavior more granularly. They are described in the following. See also
[Extensions] above, for extensions that work also on other formats.
## Philosophy
Markdown is designed to be easy to write, and, even more importantly,
easy to read:
> A Markdown-formatted document should be publishable as-is, as plain
> text, without looking like it's been marked up with tags or formatting
> instructions.
> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
This principle has guided pandoc's decisions in finding syntax for
tables, footnotes, and other extensions.
There is, however, one respect in which pandoc's aims are different
from the original aims of Markdown. Whereas Markdown was originally
designed with HTML generation in mind, pandoc is designed for multiple
output formats. Thus, while pandoc allows the embedding of raw HTML,
it discourages it, and provides other, non-HTMLish ways of representing
important document elements like definition lists, tables, mathematics, and
footnotes.
## Paragraphs
A paragraph is one or more lines of text followed by one or more blank lines.
Newlines are treated as spaces, so you can reflow your paragraphs as you like.
If you need a hard line break, put two or more spaces at the end of a line.
#### Extension: `escaped_line_breaks` ####
A backslash followed by a newline is also a hard line break.
Note: in multiline and grid table cells, this is the only way
to create a hard line break, since trailing spaces in the cells
are ignored.
## Headings
There are two kinds of headings: Setext and ATX.
### Setext-style headings ###
A setext-style heading is a line of text "underlined" with a row of `=` signs
(for a level-one heading) or `-` signs (for a level-two heading):
A level-one heading
===================
A level-two heading
-------------------
The heading text can contain inline formatting, such as emphasis (see
[Inline formatting], below).
### ATX-style headings ###
An ATX-style heading consists of one to six `#` signs and a line of
text, optionally followed by any number of `#` signs. The number of
`#` signs at the beginning of the line is the heading level:
## A level-two heading
### A level-three heading ###
As with setext-style headings, the heading text can contain formatting:
# A level-one heading with a [link](/url) and *emphasis*
#### Extension: `blank_before_header` ####
Standard Markdown syntax does not require a blank line before a heading.
Pandoc does require this (except, of course, at the beginning of the
document). The reason for the requirement is that it is all too easy for a
`#` to end up at the beginning of a line by accident (perhaps through line
wrapping). Consider, for example:
I like several of their flavors of ice cream:
#22, for example, and #5.
#### Extension: `space_in_atx_header` ####
Many Markdown implementations do not require a space between the
opening `#`s of an ATX heading and the heading text, so that
`#5 bolt` and `#hashtag` count as headings. With this extension,
pandoc does require the space.
### Heading identifiers ###
See also the [`auto_identifiers`
extension](#extension-auto_identifiers) above.
#### Extension: `header_attributes` ####
Headings can be assigned attributes using this syntax at the end
of the line containing the heading text:
{#identifier .class .class key=value key=value}
Thus, for example, the following headings will all be assigned the identifier
`foo`:
# My heading {#foo}
## My heading ## {#foo}
My other heading {#foo}
---------------
(This syntax is compatible with [PHP Markdown Extra].)
Note that although this syntax allows assignment of classes and key/value
attributes, writers generally don't use all of this information. Identifiers,
classes, and key/value attributes are used in HTML and HTML-based formats such
as EPUB and slidy. Identifiers are used for labels and link anchors in the
LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
Headings with the class `unnumbered` will not be numbered, even if
`--number-sections` is specified. A single hyphen (`-`) in an attribute
context is equivalent to `.unnumbered`, and preferable in non-English
documents. So,
# My heading {-}
is just the same as
# My heading {.unnumbered}
If the `unlisted` class is present in addition to `unnumbered`,
the heading will not be included in a table of contents.
(Currently this feature is only implemented for certain
formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
#### Extension: `implicit_header_references` ####
Pandoc behaves as if reference links have been defined for each heading.
So, to link to a heading
# Heading identifiers in HTML
you can simply write
[Heading identifiers in HTML]
or
[Heading identifiers in HTML][]
or
[the section on heading identifiers][heading identifiers in
HTML]
instead of giving the identifier explicitly:
[Heading identifiers in HTML](#heading-identifiers-in-html)
If there are multiple headings with identical text, the corresponding
reference will link to the first one only, and you will need to use explicit
links to link to the others, as described above.
Like regular reference links, these references are case-insensitive.
Explicit link reference definitions always take priority over
implicit heading references. So, in the following example, the
link will point to `bar`, not to `#foo`:
# Foo
[foo]: bar
See [foo]
## Block quotations
Markdown uses email conventions for quoting blocks of text.
A block quotation is one or more paragraphs or other block elements
(such as lists or headings), with each line preceded by a `>` character
and an optional space. (The `>` need not start at the left margin, but
it should not be indented more than three spaces.)
> This is a block quote. This
> paragraph has two lines.
>
> 1. This is a list inside a block quote.
> 2. Second item.
A "lazy" form, which requires the `>` character only on the first
line of each block, is also allowed:
> This is a block quote. This
paragraph has two lines.
> 1. This is a list inside a block quote.
2. Second item.
Among the block elements that can be contained in a block quote are
other block quotes. That is, block quotes can be nested:
> This is a block quote.
>
> > A block quote within a block quote.
If the `>` character is followed by an optional space, that space
will be considered part of the block quote marker and not part of
the indentation of the contents. Thus, to put an indented code
block in a block quote, you need five spaces after the `>`:
> code
#### Extension: `blank_before_blockquote` ####
Standard Markdown syntax does not require a blank line before a
block quote. Pandoc does require this (except, of course, at
the beginning of the document). The reason for the requirement
is that it is all too easy for a `>` to end up at the beginning
of a line by accident (perhaps through line wrapping). So,
unless the `markdown_strict` format is used, the following does
not produce a nested block quote in pandoc:
> This is a block quote.
>> Nested.
## Verbatim (code) blocks
### Indented code blocks ###
A block of text indented four spaces (or one tab) is treated as verbatim
text: that is, special characters do not trigger special formatting,
and all spaces and line breaks are preserved. For example,
if (a > 3) {
moveShip(5 * gravity, DOWN);
}
The initial (four space or one tab) indentation is not considered part
of the verbatim text, and is removed in the output.
Note: blank lines in the verbatim text need not begin with four spaces.
### Fenced code blocks ###
#### Extension: `fenced_code_blocks` ####
In addition to standard indented code blocks, pandoc supports
*fenced* code blocks. These begin with a row of three or more
tildes (`~`) and end with a row of tildes that must be at least as long as
the starting row. Everything between these lines is treated as code. No
indentation is necessary:
~~~~~~~
if (a > 3) {
moveShip(5 * gravity, DOWN);
}
~~~~~~~
Like regular code blocks, fenced code blocks must be separated
from surrounding text by blank lines.
If the code itself contains a row of tildes or backticks, just use a longer
row of tildes or backticks at the start and end:
~~~~~~~~~~~~~~~~
~~~~~~~~~~
code including tildes
~~~~~~~~~~
~~~~~~~~~~~~~~~~
#### Extension: `backtick_code_blocks` ####
Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
(`~`).
#### Extension: `fenced_code_attributes` ####
Optionally, you may attach attributes to fenced or backtick code block using
this syntax:
~~~~ {#mycode .haskell .numberLines startFrom="100"}
qsort [] = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
qsort (filter (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here `mycode` is an identifier, `haskell` and `numberLines` are
classes, and `startFrom` is an attribute with value `100`. Some
output formats can use this information to do syntax
highlighting. Currently, the only output formats that uses this
information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
highlighting is supported for your output format and language,
then the code block above will appear highlighted, with numbered
lines. (To see which languages are supported, type `pandoc
--list-highlight-languages`.) Otherwise, the code block above
will appear as follows:
<pre id="mycode" class="haskell numberLines" startFrom="100">
<code>
...
</code>
</pre>
The `numberLines` (or `number-lines`) class will cause the lines
of the code block to be numbered, starting with `1` or the value
of the `startFrom` attribute. The `lineAnchors` (or
`line-anchors`) class will cause the lines to be clickable
anchors in HTML output.
A shortcut form can also be used for specifying the language of
the code block:
```haskell
qsort [] = []
```
This is equivalent to:
``` {.haskell}
qsort [] = []
```
If the `fenced_code_attributes` extension is disabled, but
input contains class attribute(s) for the code block, the first
class attribute will be printed after the opening fence as a bare
word.
To prevent all highlighting, use the `--no-highlight` flag.
To set the highlighting style, use `--highlight-style`.
For more information on highlighting, see [Syntax highlighting],
below.
## Line blocks
#### Extension: `line_blocks` ####
A line block is a sequence of lines beginning with a vertical bar (`|`)
followed by a space. The division into lines will be preserved in
the output, as will any leading spaces; otherwise, the lines will
be formatted as Markdown. This is useful for verse and addresses:
| The limerick packs laughs anatomical
| In space that is quite economical.
| But the good ones I've seen
| So seldom are clean
| And the clean ones so seldom are comical
| 200 Main St.
| Berkeley, CA 94718
The lines can be hard-wrapped if needed, but the continuation
line must begin with a space.
| The Right Honorable Most Venerable and Righteous Samuel L.
Constable, Jr.
| 200 Main St.
| Berkeley, CA 94718
Inline formatting (such as emphasis) is allowed in the content,
but not block-level formatting (such as block quotes or lists).
This syntax is borrowed from [reStructuredText].
## Lists
### Bullet lists ###
A bullet list is a list of bulleted list items. A bulleted list
item begins with a bullet (`*`, `+`, or `-`). Here is a simple
example:
* one
* two
* three
This will produce a "compact" list. If you want a "loose" list, in which
each item is formatted as a paragraph, put spaces between the items:
* one
* two
* three
The bullets need not be flush with the left margin; they may be
indented one, two, or three spaces. The bullet must be followed
by whitespace.
List items look best if subsequent lines are flush with the first
line (after the bullet):
* here is my first
list item.
* and my second.
But Markdown also allows a "lazy" format:
* here is my first
list item.
* and my second.
### Block content in list items ###
A list item may contain multiple paragraphs and other block-level
content. However, subsequent paragraphs must be preceded by a blank line
and indented to line up with the first non-space content after
the list marker.
* First paragraph.
Continued.
* Second paragraph. With a code block, which must be indented
eight spaces:
{ code }
Exception: if the list marker is followed by an indented code
block, which must begin 5 spaces after the list marker, then
subsequent paragraphs must begin two columns after the last
character of the list marker:
* code
continuation paragraph
List items may include other lists. In this case the preceding blank
line is optional. The nested list must be indented to line up with
the first non-space character after the list marker of the
containing list item.
* fruits
+ apples
- macintosh
- red delicious
+ pears
+ peaches
* vegetables
+ broccoli
+ chard
As noted above, Markdown allows you to write list items "lazily," instead of
indenting continuation lines. However, if there are multiple paragraphs or
other blocks in a list item, the first line of each must be indented.
+ A lazy, lazy, list
item.
+ Another one; this looks
bad but is legal.
Second paragraph of second
list item.
### Ordered lists ###
Ordered lists work just like bulleted lists, except that the items
begin with enumerators rather than bullets.
In standard Markdown, enumerators are decimal numbers followed
by a period and a space. The numbers themselves are ignored, so
there is no difference between this list:
1. one
2. two
3. three
and this one:
5. one
7. two
1. three
#### Extension: `fancy_lists` ####
Unlike standard Markdown, pandoc allows ordered list items to be marked
with uppercase and lowercase letters and roman numerals, in addition to
Arabic numerals. List markers may be enclosed in parentheses or followed by a
single right-parentheses or period. They must be separated from the
text that follows by at least one space, and, if the list marker is a
capital letter with a period, by at least two spaces.[^2]
[^2]: The point of this rule is to ensure that normal paragraphs
starting with people's initials, like
B. Russell was an English philosopher.
do not get treated as list items.
This rule will not prevent
(C) 2007 Joe Smith
from being interpreted as a list item. In this case, a backslash
escape can be used:
(C\) 2007 Joe Smith
The `fancy_lists` extension also allows '`#`' to be used as an
ordered list marker in place of a numeral:
#. one
#. two
#### Extension: `startnum` ####
Pandoc also pays attention to the type of list marker used, and to the
starting number, and both of these are preserved where possible in the
output format. Thus, the following yields a list with numbers followed
by a single parenthesis, starting with 9, and a sublist with lowercase
roman numerals:
9) Ninth
10) Tenth
11) Eleventh
i. subone
ii. subtwo
iii. subthree
Pandoc will start a new list each time a different type of list
marker is used. So, the following will create three lists:
(2) Two
(5) Three
1. Four
* Five
If default list markers are desired, use `#.`:
#. one
#. two
#. three
#### Extension: `task_lists` ####
Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
- [ ] an unchecked task list item
- [x] checked item
### Definition lists ###
#### Extension: `definition_lists` ####
Pandoc supports definition lists, using the syntax of
[PHP Markdown Extra] with some extensions.[^3]
Term 1
: Definition 1
Term 2 with *inline markup*
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Each term must fit on one line, which may optionally be followed by
a blank line, and must be followed by one or more definitions.
A definition begins with a colon or tilde, which may be indented one
or two spaces.
A term may have multiple definitions, and each definition may
consist of one or more block elements (paragraph, code block,
list, etc.), each indented four spaces or one tab stop. The
body of the definition (including the first line, aside from the
colon or tilde) should be indented four spaces. However, as with
other Markdown lists, you can "lazily" omit indentation except
at the beginning of a paragraph or other block element:
Term 1
: Definition
with lazy continuation.
Second paragraph of the definition.
If you leave space before the definition (as in the example above),
the text of the definition will be treated as a paragraph. In some
output formats, this will mean greater spacing between term/definition
pairs. For a more compact definition list, omit the space before the
definition:
Term 1
~ Definition 1
Term 2
~ Definition 2a
~ Definition 2b
Note that space between items in a definition list is required.
(A variant that loosens this requirement, but disallows "lazy"
hard wrapping, can be activated with `compact_definition_lists`: see
[Non-pandoc extensions], below.)
[^3]: I have been influenced by the suggestions of [David
Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
### Numbered example lists ###
#### Extension: `example_lists` ####
The special list marker `@` can be used for sequentially numbered
examples. The first list item with a `@` marker will be numbered '1',
the next '2', and so on, throughout the document. The numbered examples
need not occur in a single list; each new list using `@` will take up
where the last stopped. So, for example:
(@) My first example will be numbered (1).
(@) My second example will be numbered (2).
Explanation of examples.
(@) My third example will be numbered (3).
Numbered examples can be labeled and referred to elsewhere in the
document:
(@good) This is a good example.
As (@good) illustrates, ...
The label can be any string of alphanumeric characters, underscores,
or hyphens.
Note: continuation paragraphs in example lists must always
be indented four spaces, regardless of the length of the
list marker. That is, example lists always behave as if the
`four_space_rule` extension is set. This is because example
labels tend to be long, and indenting content to the
first non-space character after the label would be awkward.
### Ending a list ###
What if you want to put an indented code block after a list?
- item one
- item two
{ my code block }
Trouble! Here pandoc (like other Markdown implementations) will treat
`{ my code block }` as the second paragraph of item two, and not as
a code block.
To "cut off" the list after item two, you can insert some non-indented
content, like an HTML comment, which won't produce visible output in
any format:
- item one
- item two
<!-- end of list -->
{ my code block }
You can use the same trick if you want two consecutive lists instead
of one big list:
1. one
2. two
3. three
<!-- -->
1. uno
2. dos
3. tres
## Horizontal rules
A line containing a row of three or more `*`, `-`, or `_` characters
(optionally separated by spaces) produces a horizontal rule:
* * * *
---------------
## Tables
Four kinds of tables may be used. The first three kinds presuppose the use of
a fixed-width font, such as Courier. The fourth kind can be used with
proportionally spaced fonts, as it does not require lining up columns.
#### Extension: `table_captions` ####
A caption may optionally be provided with all 4 kinds of tables (as
illustrated in the examples below). A caption is a paragraph beginning
with the string `Table:` (or just `:`), which will be stripped off.
It may appear either before or after the table.
#### Extension: `simple_tables` ####
Simple tables look like this:
Right Left Center Default
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
Table: Demonstration of simple table syntax.
The header and table rows must each fit on one line. Column
alignments are determined by the position of the header text relative
to the dashed line below it:[^4]
- If the dashed line is flush with the header text on the right side
but extends beyond it on the left, the column is right-aligned.
- If the dashed line is flush with the header text on the left side
but extends beyond it on the right, the column is left-aligned.
- If the dashed line extends beyond the header text on both sides,
the column is centered.
- If the dashed line is flush with the header text on both sides,
the default alignment is used (in most cases, this will be left).
[^4]: This scheme is due to Michel Fortin, who proposed it on the
[Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
The table must end with a blank line, or a line of dashes followed by
a blank line.
The column header row may be omitted, provided a dashed line is used
to end the table. For example:
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
------- ------ ---------- -------
When the header row is omitted, column alignments are determined on the basis
of the first line of the table body. So, in the tables above, the columns
would be right, left, center, and right aligned, respectively.
#### Extension: `multiline_tables` ####
Multiline tables allow header and table rows to span multiple lines
of text (but cells that span multiple columns or rows of the table are
not supported). Here is an example:
-------------------------------------------------------------
Centered Default Right Left
Header Aligned Aligned Aligned
----------- ------- --------------- -------------------------
First row 12.0 Example of a row that
spans multiple lines.
Second row 5.0 Here's another one. Note
the blank line between
rows.
-------------------------------------------------------------
Table: Here's the caption. It, too, may span
multiple lines.
These work like simple tables, but with the following differences:
- They must begin with a row of dashes, before the header text
(unless the header row is omitted).
- They must end with a row of dashes, then a blank line.
- The rows must be separated by blank lines.
In multiline tables, the table parser pays attention to the widths of
the columns, and the writers try to reproduce these relative widths in
the output. So, if you find that one of the columns is too narrow in the
output, try widening it in the Markdown source.
The header may be omitted in multiline tables as well as simple tables:
----------- ------- --------------- -------------------------
First row 12.0 Example of a row that
spans multiple lines.
Second row 5.0 Here's another one. Note
the blank line between
rows.
----------- ------- --------------- -------------------------
: Here's a multiline table without a header.
It is possible for a multiline table to have just one row, but the row
should be followed by a blank line (and then the row of dashes that ends
the table), or the table may be interpreted as a simple table.
#### Extension: `grid_tables` ####
Grid tables look like this:
: Sample grid table.
+---------------+---------------+--------------------+
| Fruit | Price | Advantages |
+===============+===============+====================+
| Bananas | $1.34 | - built-in wrapper |
| | | - bright color |
+---------------+---------------+--------------------+
| Oranges | $2.10 | - cures scurvy |
| | | - tasty |
+---------------+---------------+--------------------+
The row of `=`s separates the header from the table body, and can be
omitted for a headerless table. The cells of grid tables may contain
arbitrary block elements (multiple paragraphs, code blocks, lists,
etc.). Cells that span multiple columns or rows are not
supported. Grid tables can be created easily using Emacs' table-mode
(`M-x table-insert`).
Alignments can be specified as with pipe tables, by putting
colons at the boundaries of the separator line after the
header:
+---------------+---------------+--------------------+
| Right | Left | Centered |
+==============:+:==============+:==================:+
| Bananas | $1.34 | built-in wrapper |
+---------------+---------------+--------------------+
For headerless tables, the colons go on the top line instead:
+--------------:+:--------------+:------------------:+
| Right | Left | Centered |
+---------------+---------------+--------------------+
##### Grid Table Limitations #####
Pandoc does not support grid tables with row spans or column spans.
This means that neither variable numbers of columns across rows nor
variable numbers of rows across columns are supported by Pandoc.
All grid tables must have the same number of columns in each row,
and the same number of rows in each column. For example, the
Docutils [sample grid tables] will not render as expected with
Pandoc.
[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
#### Extension: `pipe_tables` ####
Pipe tables look like this:
| Right | Left | Default | Center |
|------:|:-----|---------|:------:|
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
: Demonstration of pipe table syntax.
The syntax is identical to [PHP Markdown Extra tables]. The beginning and
ending pipe characters are optional, but pipes are required between all
columns. The colons indicate column alignment as shown. The header
cannot be omitted. To simulate a headerless table, include a header
with blank cells.
Since the pipes indicate column boundaries, columns need not be vertically
aligned, as they are in the above example. So, this is a perfectly
legal (though ugly) pipe table:
fruit| price
-----|-----:
apple|2.05
pear|1.37
orange|3.09
The cells of pipe tables cannot contain block elements like paragraphs
and lists, and cannot span multiple lines. If a pipe table contains a
row whose Markdown content is wider than the column width (see
`--columns`), then the table will take up the full text width and
the cell contents will wrap, with the relative cell widths determined
by the number of dashes in the line separating the table header from
the table body. (For example `---|-` would make the first column 3/4
and the second column 1/4 of the full text width.)
On the other hand, if no lines are wider than column width, then
cell contents will not be wrapped, and the cells will be sized
to their contents.
Note: pandoc also recognizes pipe tables of the following
form, as can be produced by Emacs' orgtbl-mode:
| One | Two |
|-----+-------|
| my | table |
| is | nice |
The difference is that `+` is used instead of `|`. Other orgtbl features
are not supported. In particular, to get non-default column alignment,
you'll need to add colons as above.
[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
## Metadata blocks
#### Extension: `pandoc_title_block` ####
If the file begins with a title block
% title
% author(s) (separated by semicolons)
% date
it will be parsed as bibliographic information, not regular text. (It
will be used, for example, in the title of standalone LaTeX or HTML
output.) The block may contain just a title, a title and an author,
or all three elements. If you want to include an author but no
title, or a title and a date but no author, you need a blank line:
```
%
% Author
```
```
% My title
%
% June 15, 2006
```
The title may occupy multiple lines, but continuation lines must
begin with leading space, thus:
```
% My title
on multiple lines
```
If a document has multiple authors, the authors may be put on
separate lines with leading space, or separated by semicolons, or
both. So, all of the following are equivalent:
```
% Author One
Author Two
```
```
% Author One; Author Two
```
```
% Author One;
Author Two
```
The date must fit on one line.
All three metadata fields may contain standard inline formatting
(italics, links, footnotes, etc.).
Title blocks will always be parsed, but they will affect the output only
when the `--standalone` (`-s`) option is chosen. In HTML output, titles
will appear twice: once in the document head -- this is the title that
will appear at the top of the window in a browser -- and once at the
beginning of the document body. The title in the document head can have
an optional prefix attached (`--title-prefix` or `-T` option). The title
in the body appears as an H1 element with class "title", so it can be
suppressed or reformatted with CSS. If a title prefix is specified with
`-T` and no title block appears in the document, the title prefix will
be used by itself as the HTML title.
The man page writer extracts a title, man page section number, and
other header and footer information from the title line. The title
is assumed to be the first word on the title line, which may optionally
end with a (single-digit) section number in parentheses. (There should
be no space between the title and the parentheses.) Anything after
this is assumed to be additional footer and header text. A single pipe
character (`|`) should be used to separate the footer text from the header
text. Thus,
% PANDOC(1)
will yield a man page with the title `PANDOC` and section 1.
% PANDOC(1) Pandoc User Manuals
will also have "Pandoc User Manuals" in the footer.
% PANDOC(1) Pandoc User Manuals | Version 4.0
will also have "Version 4.0" in the header.
#### Extension: `yaml_metadata_block` ####
A [YAML] metadata block is a valid YAML object, delimited by a line of three
hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
(`...`) at the bottom. A YAML metadata block may occur anywhere in the
document, but if it is not at the beginning, it must be preceded by a blank
line. (Note that, because of the way pandoc concatenates input files when
several are provided, you may also keep the metadata in a separate YAML file
and pass it to pandoc as an argument, along with your Markdown files:
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
Just be sure that the YAML file begins with `---` and ends with `---` or
`...`.) Alternatively, you can use the `--metadata-file` option. Using
that approach however, you cannot reference content (like footnotes)
from the main markdown input document.
Metadata will be taken from the fields of the YAML object and added to any
existing document metadata. Metadata can contain lists and objects (nested
arbitrarily), but all string scalars will be interpreted as Markdown. Fields
with names ending in an underscore will be ignored by pandoc. (They may be
given a role by external processors.) Field names must not be
interpretable as YAML numbers or boolean values (so, for
example, `yes`, `True`, and `15` cannot be used as field names).
A document may contain multiple metadata blocks. If two
metadata blocks attempt to set the same field, the value from
the second block will be taken.
When pandoc is used with `-t markdown` to create a Markdown document,
a YAML metadata block will be produced only if the `-s/--standalone`
option is used. All of the metadata will appear in a single block
at the beginning of the document.
Note that [YAML] escaping rules must be followed. Thus, for example,
if a title contains a colon, it must be quoted. The pipe character
(`|`) can be used to begin an indented block that will be interpreted
literally, without need for escaping. This form is necessary
when the field contains blank lines or block-level formatting:
---
title: 'This is the title: it contains a colon'
author:
- Author One
- Author Two
keywords: [nothing, nothingness]
abstract: |
This is the abstract.
It consists of two paragraphs.
...
Template variables will be set automatically from the metadata. Thus, for
example, in writing HTML, the variable `abstract` will be set to the HTML
equivalent of the Markdown in the `abstract` field:
<p>This is the abstract.</p>
<p>It consists of two paragraphs.</p>
Variables can contain arbitrary YAML structures, but the template must match
this structure. The `author` variable in the default templates expects a
simple list or string, but can be changed to support more complicated
structures. The following combination, for example, would add an affiliation
to the author if one is given:
---
title: The document title
author:
- name: Author One
affiliation: University of Somewhere
- name: Author Two
affiliation: University of Nowhere
...
To use the structured authors in the example above, you would need a custom
template:
$for(author)$
$if(author.name)$
$author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
$else$
$author$
$endif$
$endfor$
Raw content to include in the document's header may be specified
using `header-includes`; however, it is important to mark up
this content as raw code for a particular output format, using
the [`raw_attribute` extension](#extension-raw_attribute)), or it
will be interpreted as markdown. For example:
header-includes:
- |
```{=latex}
\let\oldsection\section
\renewcommand{\section}[1]{\clearpage\oldsection{#1}}
```
Note: the `yaml_metadata_block` extension works with
`commonmark` as well as `markdown` (and it is enabled by default
in `gfm` and `commonmark_x`). However, in these formats the
following restrictions apply:
- The YAML metadata block must occur at the beginning of the
document (and there can be only one). If multiple files are
given as arguments to pandoc, only the first can be a YAML
metadata block.
- The leaf nodes of the YAML structure are parsed in isolation from
each other and from the rest of the document. So, for
example, you can't use a reference link in these contexts
if the link definition is somewhere else in the document.
## Backslash escapes
#### Extension: `all_symbols_escapable` ####
Except inside a code block or inline code, any punctuation or space
character preceded by a backslash will be treated literally, even if it
would normally indicate formatting. Thus, for example, if one writes
*\*hello\**
one will get
<em>*hello*</em>
instead of
<strong>hello</strong>
This rule is easier to remember than standard Markdown's rule,
which allows only the following characters to be backslash-escaped:
\`*_{}[]()>#+-.!
(However, if the `markdown_strict` format is used, the standard Markdown rule
will be used.)
A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
it will appear as `~`. In HTML and XML output, it will appear as a
literal unicode nonbreaking space character (note that it will thus
actually look "invisible" in the generated HTML source; you can still
use the `--ascii` command-line option to make it appear as an explicit
entity).
A backslash-escaped newline (i.e. a backslash occurring at the end of
a line) is parsed as a hard line break. It will appear in TeX output as
`\\` and in HTML as `<br />`. This is a nice alternative to
Markdown's "invisible" way of indicating hard line breaks using
two trailing spaces on a line.
Backslash escapes do not work in verbatim contexts.
## Inline formatting
### Emphasis ###
To *emphasize* some text, surround it with `*`s or `_`, like this:
This text is _emphasized with underscores_, and this
is *emphasized with asterisks*.
Double `*` or `_` produces **strong emphasis**:
This is **strong emphasis** and __with underscores__.
A `*` or `_` character surrounded by spaces, or backslash-escaped,
will not trigger emphasis:
This is * not emphasized *, and \*neither is this\*.
#### Extension: `intraword_underscores` ####
Because `_` is sometimes used inside words and identifiers,
pandoc does not interpret a `_` surrounded by alphanumeric
characters as an emphasis marker. If you want to emphasize
just part of a word, use `*`:
feas*ible*, not feas*able*.
### Strikeout ###
#### Extension: `strikeout` ####
To strikeout a section of text with a horizontal line, begin and end it
with `~~`. Thus, for example,
This ~~is deleted text.~~
### Superscripts and subscripts ###
#### Extension: `superscript`, `subscript` ####
Superscripts may be written by surrounding the superscripted text by `^`
characters; subscripts may be written by surrounding the subscripted
text by `~` characters. Thus, for example,
H~2~O is a liquid. 2^10^ is 1024.
The text between `^...^` or `~...~` may not contain spaces or
newlines. If the superscripted or subscripted text contains
spaces, these spaces must be escaped with backslashes. (This is
to prevent accidental superscripting and subscripting through
the ordinary use of `~` and `^`, and also bad interactions with
footnotes.) Thus, if you want the letter P with 'a cat' in
subscripts, use `P~a\ cat~`, not `P~a cat~`.
### Verbatim ###
To make a short span of text verbatim, put it inside backticks:
What is the difference between `>>=` and `>>`?
If the verbatim text includes a backtick, use double backticks:
Here is a literal backtick `` ` ``.
(The spaces after the opening backticks and before the closing
backticks will be ignored.)
The general rule is that a verbatim span starts with a string
of consecutive backticks (optionally followed by a space)
and ends with a string of the same number of backticks (optionally
preceded by a space).
Note that backslash-escapes (and other Markdown constructs) do not
work in verbatim contexts:
This is a backslash followed by an asterisk: `\*`.
#### Extension: `inline_code_attributes` ####
Attributes can be attached to verbatim text, just as with
[fenced code blocks]:
`<$>`{.haskell}
### Small caps ###
To write small caps, use the `smallcaps` class:
[Small caps]{.smallcaps}
Or, without the `bracketed_spans` extension:
<span class="smallcaps">Small caps</span>
For compatibility with other Markdown flavors, CSS is also supported:
<span style="font-variant:small-caps;">Small caps</span>
This will work in all output formats that support small caps.
## Math
#### Extension: `tex_math_dollars` ####
Anything between two `$` characters will be treated as TeX math. The
opening `$` must have a non-space character immediately to its right,
while the closing `$` must have a non-space character immediately to its
left, and must not be followed immediately by a digit. Thus,
`$20,000 and $30,000` won't parse as math. If for some reason
you need to enclose text in literal `$` characters, backslash-escape
them and they won't be treated as math delimiters.
For display math, use `$$` delimiters. (In this case, the delimiters
may be separated from the formula by whitespace. However, there can be
no blank lines betwen the opening and closing `$$` delimiters.)
TeX math will be printed in all output formats. How it is rendered
depends on the output format:
LaTeX
~ It will appear verbatim surrounded by `\(...\)` (for inline
math) or `\[...\]` (for display math).
Markdown, Emacs Org mode, ConTeXt, ZimWiki
~ It will appear verbatim surrounded by `$...$` (for inline
math) or `$$...$$` (for display math).
XWiki
~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
reStructuredText
~ It will be rendered using an [interpreted text role `:math:`].
AsciiDoc
~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
surrounded by `latexmath:[$...$]` (for inline math) or
`[latexmath]++++\[...\]+++` (for display math).
For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
(`$..$` and `\[..\]`) are omitted.
Texinfo
~ It will be rendered inside a `@math` command.
roff man, Jira markup
~ It will be rendered verbatim without `$`'s.
MediaWiki, DokuWiki
~ It will be rendered inside `<math>` tags.
Textile
~ It will be rendered inside `<span class="math">` tags.
RTF, OpenDocument
~ It will be rendered, if possible, using Unicode characters,
and will otherwise appear verbatim.
ODT
~ It will be rendered, if possible, using MathML.
DocBook
~ If the `--mathml` flag is used, it will be rendered using MathML
in an `inlineequation` or `informalequation` tag. Otherwise it
will be rendered, if possible, using Unicode characters.
Docx
~ It will be rendered using OMML math markup.
FictionBook2
~ If the `--webtex` option is used, formulas are rendered as images
using CodeCogs or other compatible web service, downloaded
and embedded in the e-book. Otherwise, they will appear verbatim.
HTML, Slidy, DZSlides, S5, EPUB
~ The way math is rendered in HTML will depend on the
command-line options selected. Therefore see [Math rendering in HTML]
above.
[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
## Raw HTML
#### Extension: `raw_html` ####
Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
(except verbatim contexts, where `<`, `>`, and `&` are interpreted
literally). (Technically this is not an extension, since standard
Markdown allows it, but it has been made an extension so that it can
be disabled if desired.)
The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
output, and suppressed in other formats.
For a more explicit way of including raw HTML in a Markdown
document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
In the CommonMark format, if `raw_html` is enabled, superscripts,
subscripts, strikeouts and small capitals will be represented as HTML.
Otherwise, plain-text fallbacks will be used. Note that even if
`raw_html` is disabled, tables will be rendered with HTML syntax if
they cannot use pipe syntax.
#### Extension: `markdown_in_html_blocks` ####
Standard Markdown allows you to include HTML "blocks": blocks
of HTML between balanced tags that are separated from the surrounding text
with blank lines, and start and end at the left margin. Within
these blocks, everything is interpreted as HTML, not Markdown;
so (for example), `*` does not signify emphasis.
Pandoc behaves this way when the `markdown_strict` format is used; but
by default, pandoc interprets material between HTML block tags as Markdown.
Thus, for example, pandoc will turn
<table>
<tr>
<td>*one*</td>
<td>[a link](https://google.com)</td>
</tr>
</table>
into
<table>
<tr>
<td><em>one</em></td>
<td><a href="https://google.com">a link</a></td>
</tr>
</table>
whereas `Markdown.pl` will preserve it as is.
There is one exception to this rule: text between `<script>`,
`<style>`, and `<textarea>` tags is not interpreted as Markdown.
This departure from standard Markdown should make it easier to mix
Markdown with HTML block elements. For example, one can surround
a block of Markdown text with `<div>` tags without preventing it
from being interpreted as Markdown.
#### Extension: `native_divs` ####
Use native pandoc `Div` blocks for content inside `<div>` tags.
For the most part this should give the same output as
`markdown_in_html_blocks`, but it makes it easier to write pandoc
filters to manipulate groups of blocks.
#### Extension: `native_spans` ####
Use native pandoc `Span` blocks for content inside `<span>` tags.
For the most part this should give the same output as `raw_html`,
but it makes it easier to write pandoc filters to manipulate groups
of inlines.
#### Extension: `raw_tex` ####
In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
included in a document. Inline TeX commands will be preserved and passed
unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
LaTeX to include BibTeX citations:
This result was proved in \cite{jones.1967}.
Note that in LaTeX environments, like
\begin{tabular}{|l|l|}\hline
Age & Frequency \\ \hline
18--25 & 15 \\
26--35 & 33 \\
36--45 & 22 \\ \hline
\end{tabular}
the material between the begin and end tags will be interpreted as raw
LaTeX, not as Markdown.
For a more explicit and flexible way of including raw TeX in a
Markdown document, see the [`raw_attribute`
extension][Extension: `raw_attribute`].
Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
Emacs Org mode, and ConTeXt.
### Generic raw attribute ###
#### Extension: `raw_attribute` ####
Inline spans and fenced code blocks with a special
kind of attribute will be parsed as raw content with the
designated format. For example, the following produces a raw
roff `ms` block:
```{=ms}
.MYMACRO
blah blah
```
And the following produces a raw `html` inline element:
This is `<a>html</a>`{=html}
This can be useful to insert raw xml into `docx` documents, e.g.
a pagebreak:
```{=openxml}
<w:p>
<w:r>
<w:br w:type="page"/>
</w:r>
</w:p>
```
The format name should match the target format name (see
`-t/--to`, above, for a list, or use `pandoc
--list-output-formats`). Use `openxml` for `docx` output,
`opendocument` for `odt` output, `html5` for `epub3` output,
`html4` for `epub2` output, and `latex`, `beamer`,
`ms`, or `html5` for `pdf` output (depending on what you
use for `--pdf-engine`).
This extension presupposes that the relevant kind of
inline code or fenced code block is enabled. Thus, for
example, to use a raw attribute with a backtick code block,
`backtick_code_blocks` must be enabled.
The raw attribute cannot be combined with regular attributes.
## LaTeX macros
#### Extension: `latex_macros` ####
When this extension is enabled, pandoc will parse LaTeX
macro definitions and apply the resulting macros to all LaTeX
math and raw LaTeX. So, for example, the following will work in
all output formats, not just LaTeX:
\newcommand{\tuple}[1]{\langle #1 \rangle}
$\tuple{a, b, c}$
Note that LaTeX macros will not be applied if they occur
inside a raw span or block marked with the
[`raw_attribute` extension](#extension-raw_attribute).
When `latex_macros` is disabled, the raw LaTeX and math will
not have macros applied. This is usually a better approach when
you are targeting LaTeX or PDF.
Macro definitions in LaTeX will be passed through as raw LaTeX
only if `latex_macros` is not enabled. Macro definitions in
Markdown source (or other formats allowing `raw_tex`) will
be passed through regardless of whether `latex_macros` is
enabled.
## Links
Markdown allows links to be specified in several ways.
### Automatic links ###
If you enclose a URL or email address in pointy brackets, it
will become a link:
<https://google.com>
<sam@green.eggs.ham>
### Inline links ###
An inline link consists of the link text in square brackets,
followed by the URL in parentheses. (Optionally, the URL can
be followed by a link title, in quotes.)
This is an [inline link](/url), and here's [one with
a title](https://fsf.org "click here for a good time!").
There can be no space between the bracketed part and the parenthesized part.
The link text can contain formatting (such as emphasis), but the title cannot.
Email addresses in inline links are not autodetected, so they have to be
prefixed with `mailto`:
[Write me!](mailto:sam@green.eggs.ham)
### Reference links ###
An *explicit* reference link has two parts, the link itself and the link
definition, which may occur elsewhere in the document (either
before or after the link).
The link consists of link text in square brackets, followed by a label in
square brackets. (There cannot be space between the two unless the
`spaced_reference_links` extension is enabled.) The link definition
consists of the bracketed label, followed by a colon and a space, followed by
the URL, and optionally (after a space) a link title either in quotes or in
parentheses. The label must not be parseable as a citation (assuming
the `citations` extension is enabled): citations take precedence over
link labels.
Here are some examples:
[my label 1]: /foo/bar.html "My title, optional"
[my label 2]: /foo
[my label 3]: https://fsf.org (The free software foundation)
[my label 4]: /bar#special 'A title in single quotes'
The URL may optionally be surrounded by angle brackets:
[my label 5]: <http://foo.bar.baz>
The title may go on the next line:
[my label 3]: https://fsf.org
"The free software foundation"
Note that link labels are not case sensitive. So, this will work:
Here is [my link][FOO]
[Foo]: /bar/baz
In an *implicit* reference link, the second pair of brackets is
empty:
See [my website][].
[my website]: http://foo.bar.baz
Note: In `Markdown.pl` and most other Markdown implementations,
reference link definitions cannot occur in nested constructions
such as list items or block quotes. Pandoc lifts this arbitrary
seeming restriction. So the following is fine in pandoc, though
not in most other implementations:
> My block [quote].
>
> [quote]: /foo
#### Extension: `shortcut_reference_links` ####
In a *shortcut* reference link, the second pair of brackets may
be omitted entirely:
See [my website].
[my website]: http://foo.bar.baz
### Internal links ###
To link to another section of the same document, use the automatically
generated identifier (see [Heading identifiers]). For example:
See the [Introduction](#introduction).
or
See the [Introduction].
[Introduction]: #introduction
Internal links are currently supported for HTML formats (including
HTML slide shows and EPUB), LaTeX, and ConTeXt.
## Images
A link immediately preceded by a `!` will be treated as an image.
The link text will be used as the image's alt text:
![movie reel]
[movie reel]: movie.gif
#### Extension: `implicit_figures` ####
An image with nonempty alt text, occurring by itself in a
paragraph, will be rendered as a figure with a caption. The
image's alt text will be used as the caption.
How this is rendered depends on the output format. Some output
formats (e.g. RTF) do not yet support figures. In those
formats, you'll just get an image in a paragraph by itself, with
no caption.
If you just want a regular inline image, just make sure it is not
the only thing in the paragraph. One way to do this is to insert a
nonbreaking space after the image:
\
Note that in reveal.js slide shows, an image in a paragraph
by itself that has the `stretch` class will fill the screen,
and the caption and figure tags will be omitted.
#### Extension: `link_attributes` ####
Attributes can be set on links and images:
An inline {#id .class width=30 height=20px}
and a reference ![image][ref] with attributes.
[ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
(This syntax is compatible with [PHP Markdown Extra] when only `#id`
and `.class` are used.)
For HTML and EPUB, all known HTML5 attributes except `width` and
`height` (but including `srcset` and `sizes`) are passed through
as is. Unknown attributes are passed through as custom
attributes, with `data-` prepended. The other writers ignore
attributes that are not specifically supported by their output format.
The `width` and `height` attributes on images are treated specially. When
used without a unit, the unit is assumed to be pixels. However, any of
the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
and `%`. There must not be any spaces between the number and the unit.
For example:
```
{ width=50% }
```
- Dimensions may be converted to a form that is compatible with
the output format (for example, dimensions given in pixels will
be converted to inches when converting HTML to LaTeX). Conversion
between pixels and physical measurements is affected by the
`--dpi` option (by default, 96 dpi is assumed, unless the image
itself contains dpi information).
- The `%` unit is generally relative to some available space.
For example the above example will render to the following.
- HTML: `<img href="file.jpg" style="width: 50%;" />`
- LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
(If you're using a custom template, you need to configure `graphicx`
as in the default template.)
- ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
- Some output formats have a notion of a class
([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
or a unique identifier (LaTeX `\caption`), or both (HTML).
- When no `width` or `height` attributes are specified, the fallback
is to look at the image resolution and the dpi metadata embedded in
the image file.
## Divs and Spans
Using the `native_divs` and `native_spans` extensions
(see [above][Extension: `native_divs`]), HTML syntax can
be used as part of markdown to create native `Div` and `Span`
elements in the pandoc AST (as opposed to raw HTML).
However, there is also nicer syntax available:
#### Extension: `fenced_divs` ####
Allow special fenced syntax for native `Div` blocks. A Div
starts with a fence containing at least three consecutive
colons plus some attributes. The attributes may optionally
be followed by another string of consecutive colons.
The attribute syntax is exactly as in fenced code blocks (see
[Extension: `fenced_code_attributes`]). As with fenced
code blocks, one can use either attributes in curly braces
or a single unbraced word, which will be treated as a class
name. The Div ends with another line containing a string of at
least three consecutive colons. The fenced Div should be
separated by blank lines from preceding and following blocks.
Example:
::::: {#special .sidebar}
Here is a paragraph.
And another.
:::::
Fenced divs can be nested. Opening fences are distinguished
because they *must* have attributes:
::: Warning ::::::
This is a warning.
::: Danger
This is a warning within a warning.
:::
::::::::::::::::::
Fences without attributes are always closing fences. Unlike
with fenced code blocks, the number of colons in the closing
fence need not match the number in the opening fence. However,
it can be helpful for visual clarity to use fences of different
lengths to distinguish nested divs from their parents.
#### Extension: `bracketed_spans` ####
A bracketed sequence of inlines, as one would use to begin
a link, will be treated as a `Span` with attributes if it is
followed immediately by attributes:
[This is *some text*]{.class key="val"}
## Footnotes
#### Extension: `footnotes` ####
Pandoc's Markdown allows footnotes, using the following syntax:
Here is a footnote reference,[^1] and another.[^longnote]
[^1]: Here is the footnote.
[^longnote]: Here's one with multiple blocks.
Subsequent paragraphs are indented to show that they
belong to the previous footnote.
{ some.code }
The whole paragraph can be indented, or just the first
line. In this way, multi-paragraph footnotes work like
multi-paragraph list items.
This paragraph won't be part of the note, because it
isn't indented.
The identifiers in footnote references may not contain spaces, tabs,
or newlines. These identifiers are used only to correlate the
footnote reference with the note itself; in the output, footnotes
will be numbered sequentially.
The footnotes themselves need not be placed at the end of the
document. They may appear anywhere except inside other block elements
(lists, block quotes, tables, etc.). Each footnote should be
separated from surrounding content (including other footnotes)
by blank lines.
#### Extension: `inline_notes` ####
Inline footnotes are also allowed (though, unlike regular notes,
they cannot contain multiple paragraphs). The syntax is as follows:
Here is an inline note.^[Inlines notes are easier to write, since
you don't have to pick an identifier and move down to type the
note.]
Inline and regular footnotes may be mixed freely.
## Citation syntax
#### Extension: `citations` ####
Markdown citations go inside square brackets and are separated
by semicolons. Each citation must have a key, composed of '@' +
the citation identifier from the database, and may optionally
have a prefix, a locator, and a suffix. The citation key must
begin with a letter, digit, or `_`, and may contain
alphanumerics, `_`, and internal punctuation characters
(`:.#$%&-+?<>~/`). Here are some examples:
Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
Blah blah [@smith04; @doe99].
`pandoc` detects locator terms in the [CSL locale files].
Either abbreviated or unabbreviated forms are accepted. In the `en-US`
locale, locator terms can be written in either singular or plural forms,
as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
locator term is used, "page" is assumed.
`pandoc` will use heuristics to distinguish the locator
from the suffix. In complex cases, the locator can be enclosed
in curly braces:
[@smith{ii, A, D-Z}, with a suffix]
[@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
A minus sign (`-`) before the `@` will suppress mention of
the author in the citation. This can be useful when the
author is already mentioned in the text:
Smith says blah [-@smith04].
You can also write an in-text citation, as follows:
@smith04 says blah.
@smith04 [p. 33] says blah.
[CSL]: https://docs.citationstyles.org/en/stable/specification.html
[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
[Chicago Manual of Style]: https://chicagomanualofstyle.org
[Citation Style Language]: https://citationstyles.org
[Zotero Style Repository]: https://www.zotero.org/styles
[finding and editing styles]: https://citationstyles.org/authors/
[CSL locale files]: https://github.com/citation-style-language/locales
## Non-pandoc extensions
The following Markdown syntax extensions are not enabled by default
in pandoc, but may be enabled by adding `+EXTENSION` to the format
name, where `EXTENSION` is the name of the extension. Thus, for
example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
#### Extension: `attributes` ####
Allows attributes to be attached to any inline or block-level
element. The syntax for the attributes is the same as that
used in [`header_attributes`][Extension: `header_attributes`].
- Attributes that occur immediately after an inline
element affect that element. If they follow a space, then they
belong to the space. (Hence, this option subsumes
`inline_code_attributes` and `link_attributes`.)
- Attributes that occur immediately before a block
element, on a line by themselves, affect that
element.
- Consecutive attribute specifiers may be used,
either for blocks or for inlines. Their attributes
will be combined.
- Attributes that occur at the end of the text of
a Setext or ATX heading (separated by whitespace
from the text) affect the heading element. (Hence, this
option subsumes `header_attributes`.)
- Attributes that occur after the opening fence
in a fenced code block affect the code block element. (Hence,
this option subsumes `fenced_code_attributes`.)
- Attributes that occur at the end of a reference
link definition affect links that refer to that
definition.
Note that pandoc's AST does not currently allow attributes
to be attached to arbitrary elements. Hence a Span or Div
container will be added if needed.
#### Extension: `old_dashes` ####
Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
`-` before a numeral is an en-dash, and `--` is an em-dash.
This option only has an effect if `smart` is enabled. It is
selected automatically for `textile` input.
#### Extension: `angle_brackets_escapable` ####
Allow `<` and `>` to be backslash-escaped, as they can be in
GitHub flavored Markdown but not original Markdown. This is
implied by pandoc's default `all_symbols_escapable`.
#### Extension: `lists_without_preceding_blankline` ####
Allow a list to occur right after a paragraph, with no intervening
blank space.
#### Extension: `four_space_rule` ####
Selects the pandoc <= 2.0 behavior for parsing lists, so that
four spaces indent are needed for list item continuation
paragraphs.
#### Extension: `spaced_reference_links` ####
Allow whitespace between the two components of a reference link,
for example,
[foo] [bar].
#### Extension: `hard_line_breaks` ####
Causes all newlines within a paragraph to be interpreted as hard line
breaks instead of spaces.
#### Extension: `ignore_line_breaks` ####
Causes newlines within a paragraph to be ignored, rather than being
treated as spaces or as hard line breaks. This option is intended for
use with East Asian languages where spaces are not used between words,
but text is divided into lines for readability.
#### Extension: `east_asian_line_breaks` ####
Causes newlines within a paragraph to be ignored, rather than
being treated as spaces or as hard line breaks, when they occur
between two East Asian wide characters. This is a better choice
than `ignore_line_breaks` for texts that include a mix of East
Asian wide characters and other characters.
#### Extension: `emoji` ####
Parses textual emojis like `:smile:` as Unicode emoticons.
#### Extension: `tex_math_single_backslash` ####
Causes anything between `\(` and `\)` to be interpreted as inline
TeX math, and anything between `\[` and `\]` to be interpreted
as display TeX math. Note: a drawback of this extension is that
it precludes escaping `(` and `[`.
#### Extension: `tex_math_double_backslash` ####
Causes anything between `\\(` and `\\)` to be interpreted as inline
TeX math, and anything between `\\[` and `\\]` to be interpreted
as display TeX math.
#### Extension: `markdown_attribute` ####
By default, pandoc interprets material inside block-level tags as Markdown.
This extension changes the behavior so that Markdown is only parsed
inside block-level tags if the tags have the attribute `markdown=1`.
#### Extension: `mmd_title_block` ####
Enables a [MultiMarkdown] style title block at the top of
the document, for example:
Title: My title
Author: John Doe
Date: September 1, 2008
Comment: This is a sample mmd title block, with
a field spanning multiple lines.
See the MultiMarkdown documentation for details. If `pandoc_title_block` or
`yaml_metadata_block` is enabled, it will take precedence over
`mmd_title_block`.
#### Extension: `abbreviations` ####
Parses PHP Markdown Extra abbreviation keys, like
*[HTML]: Hypertext Markup Language
Note that the pandoc document model does not support
abbreviations, so if this extension is enabled, abbreviation keys are
simply skipped (as opposed to being parsed as paragraphs).
#### Extension: `autolink_bare_uris` ####
Makes all absolute URIs into links, even when not surrounded by
pointy braces `<...>`.
#### Extension: `mmd_link_attributes` ####
Parses multimarkdown style key-value attributes on link
and image references. This extension should not be confused with the
[`link_attributes`](#extension-link_attributes) extension.
This is a reference ![image][ref] with multimarkdown attributes.
[ref]: https://path.to/image "Image title" width=20px height=30px
id=myId class="myClass1 myClass2"
#### Extension: `mmd_header_identifiers` ####
Parses multimarkdown style heading identifiers (in square brackets,
after the heading but before any trailing `#`s in an ATX heading).
#### Extension: `compact_definition_lists` ####
Activates the definition list syntax of pandoc 1.12.x and earlier.
This syntax differs from the one described above under [Definition lists]
in several respects:
- No blank line is required between consecutive items of the
definition list.
- To get a "tight" or "compact" list, omit space between consecutive
items; the space between a term and its definition does not affect
anything.
- Lazy wrapping of paragraphs is not allowed: the entire definition must
be indented four spaces.[^6]
[^6]: To see why laziness is incompatible with relaxing the requirement
of a blank line between items, consider the following example:
bar
: definition
foo
: definition
Is this a single list item with two definitions of "bar," the first of
which is lazily wrapped, or two list items? To remove the ambiguity
we must either disallow lazy wrapping or require a blank line between
list items.
#### Extension: `gutenberg` ####
Use [Project Gutenberg] conventions for `plain` output:
all-caps for strong emphasis, surround by underscores
for regular emphasis, add extra blank space around headings.
[Project Gutenberg]: https://www.gutenberg.org
#### Extension: `sourcepos` ####
Include source position attributes when parsing `commonmark`.
For elements that accept attributes, a `data-pos` attribute
is added; other elements are placed in a surrounding
Div or Span elemnet with a `data-pos` attribute.
## Markdown variants
In addition to pandoc's extended Markdown, the following Markdown
variants are supported:
- `markdown_phpextra` (PHP Markdown Extra)
- `markdown_github` (deprecated GitHub-Flavored Markdown)
- `markdown_mmd` (MultiMarkdown)
- `markdown_strict` (Markdown.pl)
- `commonmark` (CommonMark)
- `gfm` (Github-Flavored Markdown)
- `commonmark_x` (CommonMark with many pandoc extensions)
To see which extensions are supported for a given format,
and which are enabled by default, you can use the command
pandoc --list-extensions=FORMAT
where `FORMAT` is replaced with the name of the format.
Note that the list of extensions for `commonmark`,
`gfm`, and `commonmark_x` are defined relative to default
commonmark. So, for example, `backtick_code_blocks`
does not appear as an extension, since it is enabled by
default and cannot be disabled.
# Citations
When the `--citeproc` option is used, pandoc can automatically generate
citations and a bibliography in a number of styles. Basic usage is
pandoc --citeproc myinput.txt
To use this feature, you will need to have
- a document containing citations (see [Extension: `citations`]);
- a source of bibliographic data: either an external bibliography
file or a list of `references` in the document's YAML metadata
- optionally, a [CSL] citation style.
## Specifying bibliographic data
You can specify an external bibliography using the
`bibliography` metadata field in a YAML metadata section or the
`--bibliography` command line argument. If you want to use
multiple bibliography files, you can supply multiple
`--bibliography` arguments or set `bibliography` metadata field
to YAML array. A bibliography may have any of these formats:
Format File extension
------------ --------------
BibLaTeX .bib
BibTeX .bibtex
CSL JSON .json
CSL YAML .yaml
Note that `.bib` can be used with both BibTeX and BibLaTeX files;
use the extension `.bibtex` to force interpretation as BibTeX.
In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
inside fields such as `title`; in CSL YAML databases, pandoc
Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
markup specs]:
`<i>...</i>`
: italics
`<b>...</b>`
: bold
`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
: small capitals
`<sub>...</sub>`
: subscript
`<sup>...</sup>`
: superscript
`<span class="nocase">...</span>`
: prevent a phrase from being capitalized as title case
As an alternative to specifying a bibliography file using
`--bibliography` or the YAML metadata field `bibliography`, you
can include the citation data directly in the `references` field
of the document's YAML metadata. The field should contain an
array of YAML-encoded references, for example:
---
references:
- type: article-journal
id: WatsonCrick1953
author:
- family: Watson
given: J. D.
- family: Crick
given: F. H. C.
issued:
date-parts:
- - 1953
- 4
- 25
title: 'Molecular structure of nucleic acids: a structure for
deoxyribose nucleic acid'
title-short: Molecular structure of nucleic acids
container-title: Nature
volume: 171
issue: 4356
page: 737-738
DOI: 10.1038/171737a0
URL: https://www.nature.com/articles/171737a0
language: en-GB
...
If both an external bibliography and inline (YAML metadata)
references are provided, both will be used. In case of
conflicting `id`s, the inline references will take precedence.
Note that `pandoc` can be used to produce such a YAML metadata
section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
pandoc chem.bib -s -f biblatex -t markdown
pandoc chem.json -s -f csljson -t markdown
Indeed, `pandoc` can convert between any of these
citation formats:
pandoc chem.bib -s -f biblatex -t csljson
pandoc chem.yaml -s -f markdown -t biblatex
Running pandoc on a bibliography file with the `--citeproc`
option will create a formatted bibliography in the format
of your choice:
pandoc chem.bib -s --citeproc -o chem.html
pandoc chem.bib -s --citeproc -o chem.pdf
### Capitalization in titles
If you are using a bibtex or biblatex bibliography, then observe
the following rules:
- English titles should be in title case. Non-English titles should
be in sentence case, and the `langid` field in biblatex should be
set to the relevant language. (The following values are treated
as English: `american`, `british`, `canadian`, `english`,
`australian`, `newzealand`, `USenglish`, or `UKenglish`.)
- As is standard with bibtex/biblatex, proper names should be
protected with curly braces so that they won't be lowercased
in styles that call for sentence case. For example:
title = {My Dinner with {Andre}}
- In addition, words that should remain lowercase (or camelCase)
should be protected:
title = {Spin Wave Dispersion on the {nm} Scale}
Though this is not necessary in bibtex/biblatex, it is necessary
with citeproc, which stores titles internally in sentence case,
and converts to title case in styles that require it. Here we
protect "nm" so that it doesn't get converted to "Nm" at this stage.
If you are using a CSL bibliography (either JSON or YAML), then observe
the following rules:
- All titles should be in sentence case.
- Use the `language` field for non-English titles to prevent their
conversion to title case in styles that call for this. (Conversion
happens only if `language` begins with `en` or is left empty.)
- Protect words that should not be converted to title case using
this syntax:
Spin wave dispersion on the <span class="nocase">nm</span> scale
### Conference Papers, Published vs. Unpublished
For a formally published conference paper, use the biblatex entry type
`inproceedings` (which will be mapped to CSL `paper-conference`).
For an unpublished manuscript, use the biblatex entry type
`unpublished` without an `eventtitle` field (this entry type
will be mapped to CSL `manuscript`).
For a talk, an unpublished conference paper, or a poster
presentation, use the biblatex entry type `unpublished` with an
`eventtitle` field (this entry type will be mapped to CSL
`speech`). Use the biblatex `type` field to indicate the type,
e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
too, though `eventdate` will not be rendered by most CSL styles.
Note that `venue` is for the event's venue, unlike `location`
which describes the publisher's location; do not use the latter
for an unpublished conference paper.
## Specifying a citation style
Citations and references can be formatted using any style supported by the
[Citation Style Language], listed in the [Zotero Style Repository].
These files are specified using the `--csl` option or the `csl`
(or `citation-style`) metadata field. By default, pandoc will
use the [Chicago Manual of Style] author-date format. (You can
override this default by copying a CSL style of your choice
to `default.csl` in your user data directory.)
The CSL project provides further information on [finding and
editing styles].
The `--citation-abbreviations` option (or the
`citation-abbreviations` metadata field) may be used to specify
a JSON file containing abbreviations of journals that should be
used in formatted bibliographies when `form="short"` is
specified. The format of the file can be illustrated with an
example:
{ "default": {
"container-title": {
"Lloyd's Law Reports": "Lloyd's Rep",
"Estates Gazette": "EG",
"Scots Law Times": "SLT"
}
}
}
## Citations in note styles
Pandoc's citation processing is designed to allow you to
move between author-date, numerical, and note styles without
modifying the markdown source. When you're using a note
style, avoid inserting footnotes manually. Instead, insert
citations just as you would in an author-date style---for
example,
Blah blah [@foo, p. 33].
The footnote will be created automatically. Pandoc will take
care of removing the space and moving the note before or
after the period, depending on the setting of
`notes-after-punctuation`, as described below in [Other relevant
metadata fields].
In some cases you may need to put a citation inside a regular
footnote. Normal citations in footnotes (such as `[@foo, p.
33]`) will be rendered in parentheses. In-text citations (such
as `@foo [p. 33]`) will be rendered without parentheses. (A
comma will be added if appropriate.) Thus:
[^1]: Some studies [@foo; @bar, p. 33] show that
frubulicious zoosnaps are quantical. For a survey
of the literature, see @baz [chap. 1].
## Raw content in a style
To include raw content in a prefix, suffix, delimiter, or term,
surround it with these tags indicating the format:
{{jats}}<ref>{{/jats}}
Without the tags, the string will be interpreted as a string
and escaped in the output, rather than being passed through raw.
This feature allows stylesheets to be customized to give
different output for different output formats. However,
stylesheets customized in this way will not be usable
by other CSL implementations.
## Placement of the bibliography
If the style calls for a list of works cited, it will be placed
in a div with id `refs`, if one exists:
::: {#refs}
:::
Otherwise, it will be placed at the end of the document.
Generation of the bibliography can be suppressed by setting
`suppress-bibliography: true` in the YAML metadata.
If you wish the bibliography to have a section heading, you can
set `reference-section-title` in the metadata, or put the heading
at the beginning of the div with id `refs` (if you are using it)
or at the end of your document:
last paragraph...
# References
The bibliography will be inserted after this heading. Note that
the `unnumbered` class will be added to this heading, so that the
section will not be numbered.
## Including uncited items in the bibliography
If you want to include items in the bibliography without actually
citing them in the body text, you can define a dummy `nocite` metadata
field and put the citations there:
---
nocite: |
@item1, @item2
...
@item3
In this example, the document will contain a citation for `item3`
only, but the bibliography will contain entries for `item1`, `item2`, and
`item3`.
It is possible to create a bibliography with all the citations,
whether or not they appear in the document, by using a wildcard:
---
nocite: |
@*
...
For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
render the bibliography. In order to do so, specify bibliography
files as outlined above, and add `--natbib` or `--biblatex`
argument to `pandoc` invocation. Bear in mind that bibliography
files have to be in either BibTeX (for `--natbib`)
or BibLaTeX (for `--biblatex`) format.
## Other relevant metadata fields
A few other metadata fields affect bibliography formatting:
`link-citations`
: If true, citations will be
hyperlinked to the corresponding bibliography entries
(for author-date and numerical styles only).
`lang`
: The `lang` field will affect how the style is localized,
for example in the translation of labels, the use
of quotation marks, and the way items are sorted.
(For backwards compatibility, `locale` may be used instead
of `lang`, but this use is deprecated.)
A BCP 47 language tag is expected: for example, `en`,
`de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
syntax (after `-u-`) may be used to specify options for
collation (sorting) more precisely. Here are some examples:
- `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
- `es-u-co-trad` -- Spanish with the traditional collation
(with `Ch` sorting after `C`).
- `fr-u-kb` -- French with "backwards" accent sorting
(with `coté` sorting after `côte`).
- `en-US-u-kf-upper` -- English with uppercase letters sorting
before lower (default is lower before upper).
`notes-after-punctuation`
: If true (the default), pandoc will put footnote citations
after following punctuation. For example, if the source
contains `blah blah [@jones99].`, the result will look like
`blah blah.[^1]`, with the note moved after the period and
the space collapsed. If false, the space will still be
collapsed, but the footnote will not be moved after the
punctuation.
# Slide shows
You can use pandoc to produce an HTML + JavaScript slide presentation
that can be viewed via a web browser. There are five ways to do this,
using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
You can also produce a PDF slide show using LaTeX [`beamer`], or
slides shows in Microsoft [PowerPoint] format.
Here's the Markdown source for a simple slide show, `habits.txt`:
% Habits
% John Doe
% March 22, 2005
# In the morning
## Getting up
- Turn off alarm
- Get out of bed
## Breakfast
- Eat eggs
- Drink coffee
# In the evening
## Dinner
- Eat spaghetti
- Drink wine
------------------
## Going to sleep
- Get in bed
- Count sheep
To produce an HTML/JavaScript slide show, simply type
pandoc -t FORMAT -s habits.txt -o habits.html
where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
For Slidy, Slideous, reveal.js, and S5, the file produced by
pandoc with the `-s/--standalone` option embeds a link to
JavaScript and CSS files, which are assumed to be available at
the relative path `s5/default` (for S5), `slideous` (for
Slideous), `reveal.js` (for reveal.js), or at the Slidy website
at `w3.org` (for Slidy). (These paths can be changed by setting
the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
variables; see [Variables for HTML slides], above.) For
DZSlides, the (relatively short) JavaScript and CSS are included
in the file by default.
With all HTML slide formats, the `--self-contained` option can
be used to produce a single file that contains all of the data
necessary to display the slide show, including linked scripts,
stylesheets, images, and videos.
To produce a PDF slide show using beamer, type
pandoc -t beamer habits.txt -o habits.pdf
Note that a reveal.js slide show can also be converted to a PDF
by printing it to a file from the browser.
To produce a Powerpoint slide show, type
pandoc habits.txt -o habits.pptx
## Structuring the slide show
By default, the *slide level* is the highest heading level in
the hierarchy that is followed immediately by content, and not another
heading, somewhere in the document. In the example above, level-1 headings
are always followed by level-2 headings, which are followed by content,
so the slide level is 2. This default can be overridden using
the `--slide-level` option.
The document is carved up into slides according to the following
rules:
* A horizontal rule always starts a new slide.
* A heading at the slide level always starts a new slide.
* Headings *below* the slide level in the hierarchy create
headings *within* a slide.
* Headings *above* the slide level in the hierarchy create
"title slides," which just contain the section title
and help to break the slide show into sections.
Non-slide content under these headings will be included
on the title slide (for HTML slide shows) or in a
subsequent slide with the same title (for beamer).
* A title page is constructed automatically from the document's title
block, if present. (In the case of beamer, this can be disabled
by commenting out some lines in the default template.)
These rules are designed to support many different styles of slide show. If
you don't care about structuring your slides into sections and subsections,
you can just use level-1 headings for all each slide. (In that case, level-1
will be the slide level.) But you can also structure the slide show into
sections, as in the example above.
Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
layout will be produced, with level-1 headings building horizontally
and level-2 headings building vertically. It is not recommended that
you use deeper nesting of section levels with reveal.js.
## Incremental lists
By default, these writers produce lists that display "all at once."
If you want your lists to display incrementally (one item at a time),
use the `-i` option. If you want a particular list to depart from the
default, put it in a `div` block with class `incremental` or
`nonincremental`. So, for example, using the `fenced div` syntax, the
following would be incremental regardless of the document default:
::: incremental
- Eat spaghetti
- Drink wine
:::
or
::: nonincremental
- Eat spaghetti
- Drink wine
:::
While using `incremental` and `nonincremental` divs are the
recommended method of setting incremental lists on a per-case basis,
an older method is also supported: putting lists inside a blockquote
will depart from the document default (that is, it will display
incrementally without the `-i` option and all at once with the `-i`
option):
> - Eat spaghetti
> - Drink wine
Both methods allow incremental and nonincremental lists to be mixed
in a single document.
Note: Neither the `-i/--incremental` option nor any of the
methods described here currently works for PowerPoint output.
## Inserting pauses
You can add "pauses" within a slide by including a paragraph containing
three dots, separated by spaces:
# Slide with a pause
content before the pause
. . .
content after the pause
Note: this feature is not yet implemented for PowerPoint output.
## Styling the slides
You can change the style of HTML slides by putting customized CSS files
in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
or `$DATADIR/slideous` (for Slideous),
where `$DATADIR` is the user data directory (see `--data-dir`, above).
The originals may be found in pandoc's system data directory (generally
`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any
files it does not find in the user data directory.
For dzslides, the CSS is included in the HTML file itself, and may
be modified there.
All [reveal.js configuration options] can be set through variables.
For example, themes can be used by setting the `theme` variable:
-V theme=moon
Or you can specify a custom stylesheet using the `--css` option.
To style beamer slides, you can specify a `theme`, `colortheme`,
`fonttheme`, `innertheme`, and `outertheme`, using the `-V` option:
pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
Note that heading attributes will turn into slide attributes
(on a `<div>` or `<section>`) in HTML slide formats, allowing you
to style individual slides. In beamer, the only heading attribute
that affects slides is the `allowframebreaks` class, which sets the
`allowframebreaks` option, causing multiple slides to be created
if the content overfills the frame. This is recommended especially for
bibliographies:
# References {.allowframebreaks}
## Speaker notes
Speaker notes are supported in reveal.js and PowerPoint (pptx)
output. You can add notes to your Markdown document thus:
::: notes
This is my note.
- It can contain Markdown
- like this list
:::
To show the notes window in reveal.js, press `s` while viewing the
presentation. Speaker notes in PowerPoint will be available, as usual,
in handouts and presenter view.
Notes are not yet supported for other slide formats, but the notes
will not appear on the slides themselves.
## Columns
To put material in side by side columns, you can use a native
div container with class `columns`, containing two or more div
containers with class `column` and a `width` attribute:
:::::::::::::: {.columns}
::: {.column width="40%"}
contents...
:::
::: {.column width="60%"}
contents...
:::
::::::::::::::
### Additional columns attributes in beamer
The div containers with classes `columns` and `column` can optionally have
an `align` attribute.
The class `columns` can optionally have a `totalwidth` attribute or an
`onlytextwidth` class.
:::::::::::::: {.columns align=center totalwidth=8em}
::: {.column width="40%"}
contents...
:::
::: {.column width="60%" align=bottom}
contents...
:::
::::::::::::::
The `align` attributes on `columns` and `column` can be used with the
values `top`, `top-baseline`, `center` and `bottom` to vertically align
the columns. It defaults to `top` in `columns`.
The `totalwidth` attribute limits the width of the columns to the given value.
:::::::::::::: {.columns align=top .onlytextwidth}
::: {.column width="40%" align=center}
contents...
:::
::: {.column width="60%"}
contents...
:::
::::::::::::::
The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
See Section 12.7 of the [Beamer User's Guide] for more details.
## Frame attributes in beamer
Sometimes it is necessary to add the LaTeX `[fragile]` option to
a frame in beamer (for example, when using the `minted` environment).
This can be forced by adding the `fragile` class to the heading
introducing the slide:
# Fragile slide {.fragile}
All of the other frame attributes described in Section 8.1 of
the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
`shrink`, `standout`, `noframenumbering`.
## Background in reveal.js and beamer
Background images can be added to self-contained reveal.js slideshows and
to beamer slideshows.
For the same image on every slide, use the configuration
option `background-image` either in the YAML metadata block
or as a command-line variable. (There are no other options in
beamer and the rest of this section concerns reveal.js slideshows.)
For reveal.js, you can instead use the reveal.js-native option
`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
and `parallaxBackgroundVertical` the same way and must also set
`parallaxBackgroundSize` to have your values take effect.
To set an image for a particular reveal.js slide, add
`{data-background-image="/path/to/image"}`
to the first slide-level heading on the slide (which may even be empty).
In reveal.js's overview mode, the parallaxBackgroundImage will show up
only on the first slide.
Other reveal.js background settings also work on individual slides, including
`data-background-size`, `data-background-repeat`, `data-background-color`,
`data-transition`, and `data-transition-speed`.
To add a background image to the automatically generated title slide, use the
`title-slide-attributes` variable in the YAML metadata block. It must contain
a map of attribute names and values.
See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
details.
For example in reveal.js:
```
---
title: My Slideshow
parallaxBackgroundImage: /path/to/my/background_image.png
title-slide-attributes:
data-background-image: /path/to/title_image.png
data-background-size: contain
---
## Slide One
Slide 1 has background_image.png as its background.
## {data-background-image="/path/to/special_image.jpg"}
Slide 2 has a special image for its background, even though the heading has no content.
```
# EPUBs
## EPUB Metadata
EPUB metadata may be specified using the `--epub-metadata` option, but
if the source document is Markdown, it is better to use a [YAML metadata
block][Extension: `yaml_metadata_block`]. Here is an example:
---
title:
- type: main
text: My Book
- type: subtitle
text: An investigation of metadata
creator:
- role: author
text: John Smith
- role: editor
text: Sarah Jones
identifier:
- scheme: DOI
text: doi:10.234234.234/33
publisher: My Press
rights: © 2007 John Smith, CC BY-NC
ibooks:
version: 1.3.4
...
The following fields are recognized:
`identifier`
~ Either a string value or an object with fields `text` and
`scheme`. Valid values for `scheme` are `ISBN-10`,
`GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
`ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
`ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
`title`
~ Either a string value, or an object with fields `file-as` and
`type`, or a list of such objects. Valid values for `type` are
`main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
`creator`
~ Either a string value, or an object with fields `role`, `file-as`,
and `text`, or a list of such objects. Valid values for `role` are
[MARC relators], but
pandoc will attempt to translate the human-readable versions
(like "author" and "editor") to the appropriate marc relators.
`contributor`
~ Same format as `creator`.
`date`
~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
Pandoc will attempt to convert other common date formats.
`lang` (or legacy: `language`)
~ A string value in [BCP 47] format. Pandoc will default to the local
language if nothing is specified.
`subject`
~ A string value or a list of such values.
`description`
~ A string value.
`type`
~ A string value.
`format`
~ A string value.
`relation`
~ A string value.
`coverage`
~ A string value.
`rights`
~ A string value.
`belongs-to-collection`
~ A string value. identifies the name of a collection to which
the EPUB Publication belongs.
`group-position`
~ The `group-position` field indicates the numeric position in which
the EPUB Publication belongs relative to other works belonging to
the same `belongs-to-collection` field.
`cover-image`
~ A string value (path to cover image).
`css` (or legacy: `stylesheet`)
~ A string value (path to CSS stylesheet).
`page-progression-direction`
~ Either `ltr` or `rtl`. Specifies the `page-progression-direction`
attribute for the [`spine` element].
`ibooks`
~ iBooks-specific metadata, with the following fields:
- `version`: (string)
- `specified-fonts`: `true`|`false` (default `false`)
- `ipad-orientation-lock`: `portrait-only`|`landscape-only`
- `iphone-orientation-lock`: `portrait-only`|`landscape-only`
- `binding`: `true`|`false` (default `true`)
- `scroll-axis`: `vertical`|`horizontal`|`default`
[MARC relators]: https://loc.gov/marc/relators/relaterm.html
[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
## The `epub:type` attribute
For `epub3` output, you can mark up the heading that corresponds to an EPUB
chapter using the [`epub:type` attribute][epub-type]. For example, to set
the attribute to the value `prologue`, use this markdown:
# My chapter {epub:type=prologue}
Which will result in:
<body epub:type="frontmatter">
<section epub:type="prologue">
<h1>My chapter</h1>
Pandoc will output `<body epub:type="bodymatter">`, unless
you use one of the following values, in which case either
`frontmatter` or `backmatter` will be output.
`epub:type` of first section `epub:type` of body
---------------------------- ------------------
prologue frontmatter
abstract frontmatter
acknowledgments frontmatter
copyright-page frontmatter
dedication frontmatter
credits frontmatter
keywords frontmatter
imprint frontmatter
contributors frontmatter
other-credits frontmatter
errata frontmatter
revision-history frontmatter
titlepage frontmatter
halftitlepage frontmatter
seriespage frontmatter
foreword frontmatter
preface frontmatter
appendix backmatter
colophon backmatter
bibliography backmatter
index backmatter
[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
## Linked media
By default, pandoc will download media referenced from any `<img>`, `<audio>`,
`<video>` or `<source>` element present in the generated EPUB,
and include it in the EPUB container, yielding a completely
self-contained EPUB. If you want to link to external media resources
instead, use raw HTML in your source and add `data-external="1"` to the tag
with the `src` attribute. For example:
<audio controls="1">
<source src="https://example.com/music/toccata.mp3"
data-external="1" type="audio/mpeg">
</source>
</audio>
# Jupyter notebooks
When creating a [Jupyter notebook], pandoc will try to infer the
notebook structure. Code blocks with the class `code` will be
taken as code cells, and intervening content will be taken as
Markdown cells. Attachments will automatically be created for
images in Markdown cells. Metadata will be taken from the
`jupyter` metadata field. For example:
````
---
title: My notebook
jupyter:
nbformat: 4
nbformat_minor: 5
kernelspec:
display_name: Python 2
language: python
name: python2
language_info:
codemirror_mode:
name: ipython
version: 2
file_extension: ".py"
mimetype: "text/x-python"
name: "python"
nbconvert_exporter: "python"
pygments_lexer: "ipython2"
version: "2.7.15"
---
# Lorem ipsum
**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
bibendum felis dictum sodales.
``` code
print("hello")
```
## Pyout
``` code
from IPython.display import HTML
HTML("""
<script>
console.log("hello");
</script>
<b>HTML</b>
""")
```
## Image
This image  will be
included as a cell attachment.
````
If you want to add cell attributes, group cells differently, or
add output to code cells, then you need to include divs to
indicate the structure. You can use either [fenced
divs][Extension: `fenced_divs`] or [native divs][Extension:
`native_divs`] for this. Here is an example:
````
:::::: {.cell .markdown}
# Lorem
**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
bibendum felis dictum sodales.
::::::
:::::: {.cell .code execution_count=1}
``` {.python}
print("hello")
```
::: {.output .stream .stdout}
```
hello
```
:::
::::::
:::::: {.cell .code execution_count=2}
``` {.python}
from IPython.display import HTML
HTML("""
<script>
console.log("hello");
</script>
<b>HTML</b>
""")
```
::: {.output .execute_result execution_count=2}
```{=html}
<script>
console.log("hello");
</script>
<b>HTML</b>
hello
```
:::
::::::
````
If you include raw HTML or TeX in an output cell, use the
[raw attribute][Extension: `fenced_attribute`], as shown
in the last cell of the example above. Although pandoc can
process "bare" raw HTML and TeX, the result is often
interspersed raw elements and normal textual elements, and
in an output cell pandoc expects a single, connected raw
block. To avoid using raw HTML or TeX except when
marked explicitly using raw attributes, we recommend
specifying the extensions `-raw_html-raw_tex+raw_attribute` when
translating between Markdown and ipynb notebooks.
Note that options and extensions that affect reading and
writing of Markdown will also affect Markdown cells in ipynb
notebooks. For example, `--wrap=preserve` will preserve
soft line breaks in Markdown cells; `--atx-headers` will
cause ATX-style headings to be used; and `--preserve-tabs` will
prevent tabs from being turned to spaces.
# Syntax highlighting
Pandoc will automatically highlight syntax in [fenced code blocks] that
are marked with a language name. The Haskell library [skylighting] is
used for highlighting. Currently highlighting is supported only for
HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
that pandoc will recognize, type `pandoc --list-highlight-languages`.
The color scheme can be selected using the `--highlight-style` option.
The default color scheme is `pygments`, which imitates the default color
scheme used by the Python library pygments (though pygments is not actually
used to do the highlighting). To see a list of highlight styles,
type `pandoc --list-highlight-styles`.
If you are not satisfied with the predefined styles, you can
use `--print-highlight-style` to generate a JSON `.theme` file which
can be modified and used as the argument to `--highlight-style`. To
get a JSON version of the `pygments` style, for example:
pandoc --print-highlight-style pygments > my.theme
Then edit `my.theme` and use it like this:
pandoc --highlight-style my.theme
If you are not satisfied with the built-in highlighting, or you
want highlight a language that isn't supported, you can use the
`--syntax-definition` option to load a [KDE-style XML syntax definition
file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
Before writing your own, have a look at KDE's [repository of syntax
definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
To disable highlighting, use the `--no-highlight` option.
[skylighting]: https://github.com/jgm/skylighting
# Custom Styles
Custom styles can be used in the docx and ICML formats.
## Output
By default, pandoc's docx and ICML output applies a predefined set of styles
for blocks such as paragraphs and block quotes, and uses largely default
formatting (italics, bold) for inlines. This will work for most
purposes, especially alongside a `reference.docx` file. However, if you
need to apply your own styles to blocks, or match a preexisting set of
styles, pandoc allows you to define custom styles for blocks and text
using `div`s and `span`s, respectively.
If you define a `div` or `span` with the attribute `custom-style`,
pandoc will apply your specified style to the contained elements (with
the exception of elements whose function depends on a style, like
headings, code blocks, block quotes, or links). So, for example, using
the `bracketed_spans` syntax,
[Get out]{custom-style="Emphatically"}, he said.
would produce a docx file with "Get out" styled with character
style `Emphatically`. Similarly, using the `fenced_divs` syntax,
Dickinson starts the poem simply:
::: {custom-style="Poetry"}
| A Bird came down the Walk---
| He did not know I saw---
:::
would style the two contained lines with the `Poetry` paragraph style.
For docx output, styles will be defined in the output file as inheriting
from normal text, if the styles are not yet in your reference.docx.
If they are already defined, pandoc will not alter the definition.
This feature allows for greatest customization in conjunction with
[pandoc filters]. If you want all paragraphs after block quotes to be
indented, you can write a filter to apply the styles necessary. If you
want all italics to be transformed to the `Emphasis` character style
(perhaps to change their color), you can write a filter which will
transform all italicized inlines to inlines within an `Emphasis`
custom-style `span`.
For docx output, you don't need to enable any extensions for
custom styles to work.
[pandoc filters]: https://pandoc.org/filters.html
## Input
The docx reader, by default, only reads those styles that it can
convert into pandoc elements, either by direct conversion or
interpreting the derivation of the input document's styles.
By enabling the [`styles` extension](#ext-styles) in the docx reader
(`-f docx+styles`), you can produce output that maintains the styles
of the input document, using the `custom-style` class. Paragraph
styles are interpreted as divs, while character styles are interpreted
as spans.
For example, using the `custom-style-reference.docx` file in the test
directory, we have the following different outputs:
Without the `+styles` extension:
$ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
This is some text.
This is text with an *emphasized* text style. And this is text with a
**strengthened** text style.
> Here is a styled paragraph that inherits from Block Text.
And with the extension:
$ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
::: {custom-style="First Paragraph"}
This is some text.
:::
::: {custom-style="Body Text"}
This is text with an [emphasized]{custom-style="Emphatic"} text style.
And this is text with a [strengthened]{custom-style="Strengthened"}
text style.
:::
::: {custom-style="My Block Style"}
> Here is a styled paragraph that inherits from Block Text.
:::
With these custom styles, you can use your input document as a
reference-doc while creating docx output (see below), and maintain the
same styles in your input and output files.
# Custom writers
Pandoc can be extended with custom writers written in [Lua]. (Pandoc
includes a Lua interpreter, so Lua need not be installed separately.)
To use a custom writer, simply specify the path to the Lua script
in place of the output format. For example:
pandoc -t data/sample.lua
Creating a custom writer requires writing a Lua function for each
possible element in a pandoc document. To get a documented example
which you can modify according to your needs, do
pandoc --print-default-data-file sample.lua
Note that custom writers have no default template. If you want
to use `--standalone` with a custom writer, you will need to
specify a template manually using `--template` or add a new
default template with the name
`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
subdirectory of your user data directory (see [Templates]).
[Lua]: https://www.lua.org
# Reproducible builds
Some of the document formats pandoc targets (such as EPUB,
docx, and ODT) include build timestamps in the generated document.
That means that the files generated on successive builds will
differ, even if the source does not. To avoid this, set the
`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
be taken from it instead of the current time.
`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
(specifying the number of second since midnight UTC January 1, 1970).
Some document formats also include a unique identifier. For
EPUB, this can be set explicitly by setting the `identifier`
metadata field (see [EPUB Metadata], above).
# A note on security
If you use pandoc to convert user-contributed content in a web
application, here are some things to keep in mind:
1. Although pandoc itself will not create or modify any files other
than those you explicitly ask it create (with the exception
of temporary files used in producing PDFs), a filter or custom
writer could in principle do anything on your file system. Please
audit filters and custom writers very carefully before using them.
2. If your application uses pandoc as a Haskell library (rather than
shelling out to the executable), it is possible to use it in a mode
that fully isolates pandoc from your file system, by running the
pandoc operations in the `PandocPure` monad. See the document
[Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
for more details.
3. Pandoc's parsers can exhibit pathological performance on some
corner cases. It is wise to put any pandoc operations under
a timeout, to avoid DOS attacks that exploit these issues.
If you are using the pandoc executable, you can add the
command line options `+RTS -M512M -RTS` (for example) to limit
the heap size to 512MB.
4. The HTML generated by pandoc is not guaranteed to be safe.
If `raw_html` is enabled for the Markdown input, users can
inject arbitrary HTML. Even if `raw_html` is disabled,
users can include dangerous content in attributes for
headings, spans, and code blocks. To be safe, you should
run all the generated HTML through an HTML sanitizer.
# Authors
Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
under the [GPL], version 2 or greater. This software carries no
warranty of any kind. (See COPYRIGHT for full copyright and
warranty notices.) For a full list of contributors, see the file
AUTHORS.md in the pandoc source code.
[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"
|
