aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2014-02-16 14:41:13 -0500
committerWaylan Limberg <waylan@gmail.com>2014-02-16 14:41:13 -0500
commit1144e2a94cf3f78dedda0b88649ce789fb8d1edf (patch)
tree6474587da2a36a5983adb3ad97ba62489f28f82e /docs/extensions
parent9a03243ff51ce2e868cfd2de713d7de6ae84140e (diff)
downloadmarkdown-1144e2a94cf3f78dedda0b88649ce789fb8d1edf.tar.gz
markdown-1144e2a94cf3f78dedda0b88649ce789fb8d1edf.tar.bz2
markdown-1144e2a94cf3f78dedda0b88649ce789fb8d1edf.zip
Cleaned up some minor issues with recent changes to docs.
Diffstat (limited to 'docs/extensions')
-rw-r--r--docs/extensions/code_hilite.txt21
-rw-r--r--docs/extensions/extra.txt7
-rw-r--r--docs/extensions/fenced_code_blocks.txt5
-rw-r--r--docs/extensions/footnotes.txt6
-rw-r--r--docs/extensions/header_id.txt8
-rw-r--r--docs/extensions/smarty.txt26
-rw-r--r--docs/extensions/toc.txt10
-rw-r--r--docs/extensions/wikilinks.txt8
8 files changed, 55 insertions, 36 deletions
diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt
index 2cdb123..f0648e1 100644
--- a/docs/extensions/code_hilite.txt
+++ b/docs/extensions/code_hilite.txt
@@ -32,7 +32,8 @@ language. When that fails, the code block will display as un-highlighted code.
!!! Note
The css and/or javascript is not included as part of this extension
- but shall always be provided by the end user.
+ but must be provided by the end user. The Pygments project provides
+ default css styles which you may find to be a useful starting point.
Syntax
------
@@ -90,9 +91,9 @@ Will result in:
# Code goes here ...
-Certain lines can be selected for emphasis with the colon syntax. By
-default, emphasized lines have a yellow background. This is useful to
-direct the reader's attention.
+Certain lines can be selected for emphasis with the colon syntax. When
+using Pygments' default css styles, emphasized lines have a yellow background.
+This is useful to direct the reader's attention to specific lines.
:::python hl_lines="1 3"
# This line is emphasized
@@ -135,7 +136,7 @@ configuring extensions.
The following options are provided to configure the output:
-* **linenums**:
+* **`linenums`**:
Use line numbers. Possible values are `True` for yes, `False` for no and
`None` for auto. Defaults to `None`.
@@ -145,22 +146,22 @@ The following options are provided to configure the output:
Using `False` will turn off all line numbers, even when using SheBangs
(`#!`) for language identification.
-* **guess_lang**:
+* **`guess_lang`**:
Automatic language detection. Defaults to `True`.
Using `False` will prevent Pygments from guessing the language, and thus
highlighting blocks only when you explicitly set the language.
-* **css_class**:
+* **`css_class`**:
Set CSS class name for the wrapper `<div>` tag. Defaults to
`codehilite`.
-* **pygments_style**:
+* **`pygments_style`**:
Pygments HTML Formatter Style (ColorScheme). Defaults to `default`.
!!! Note
This is useful only when `noclasses` is set to `True`, otherwise the
- CSS style shall be provided by the end user.
+ CSS styles must be provided by the end user.
-* **noclasses**:
+* **`noclasses`**:
Use inline styles instead of CSS classes. Defaults to `False`.
diff --git a/docs/extensions/extra.txt b/docs/extensions/extra.txt
index b90d1b0..ace801b 100644
--- a/docs/extensions/extra.txt
+++ b/docs/extensions/extra.txt
@@ -69,9 +69,10 @@ This is *true* markdown text.
### Nested Markdown Inside HTML BLocks
Nested elements are more sensitive and must be used cautiously. To avoid unexpected results:
- * Only nest elements within block mode elements.
- * Follow the closing tag of inner elements with a blank line.
- * Only have one level of nesting.
+
+* Only nest elements within block mode elements.
+* Follow the closing tag of inner elements with a blank line.
+* Only have one level of nesting.
#### Complex Example:
```
diff --git a/docs/extensions/fenced_code_blocks.txt b/docs/extensions/fenced_code_blocks.txt
index 206f6da..bfb65d3 100644
--- a/docs/extensions/fenced_code_blocks.txt
+++ b/docs/extensions/fenced_code_blocks.txt
@@ -35,6 +35,11 @@ Fenced code blocks can have a blank line as the first and/or last line of a
code block and they can also come immediately after a list item without becoming
part of the list.
+!!! warning
+
+ Fenced Code Blocks are only supported at the document root level.
+ Therefore, they cannot be nested inside lists or blockquotes.
+
### Language ###
In addition to PHP Extra's syntax, you can define the language of the code
diff --git a/docs/extensions/footnotes.txt b/docs/extensions/footnotes.txt
index a18fb06..0f86595 100644
--- a/docs/extensions/footnotes.txt
+++ b/docs/extensions/footnotes.txt
@@ -72,17 +72,17 @@ configuring extensions.
The following options are provided to configure the output:
-* **PLACE_MARKER**:
+* **`PLACE_MARKER`**:
A text string used to mark the position where the footnotes are rendered.
Defaults to `///Footnotes Go Here///`.
If the place marker text is not found in the document, the footnote
definitions are placed at the end of the resulting HTML document.
-* **UNIQUE_IDS**:
+* **`UNIQUE_IDS`**:
Whether to avoid collisions across multiple calls to `reset()`. Defaults to
`False`.
-* **BACKLINK_TEXT**:
+* **`BACKLINK_TEXT`**:
The text string that links from the footnote definition back to the position
in the document. Defaults to `&#8617;`.
diff --git a/docs/extensions/header_id.txt b/docs/extensions/header_id.txt
index afa1fe1..90eac3b 100644
--- a/docs/extensions/header_id.txt
+++ b/docs/extensions/header_id.txt
@@ -43,7 +43,7 @@ configuring extensions.
The following options are provided to configure the output:
-* **level**: Base level for headers.
+* **`level`**: Base level for headers.
Default: `1`
@@ -60,7 +60,7 @@ The following options are provided to configure the output:
<h3 id="some_header">Some Header</h3>
<h4 id="next_level">Next Level</h4>'
-* **forceid**: Force all headers to have an id.
+* **`forceid`**: Force all headers to have an id.
Default: `True`
@@ -77,11 +77,11 @@ The following options are provided to configure the output:
<h1>Some Header</h1>
<h1 id="foo">Header with ID</h1>
-* **separator**: Word separator. Character which replaces whitespace in id.
+* **`separator`**: Word separator. Character which replaces whitespace in id.
Default: `-`
-* **slugify**: Callable to generate anchors.
+* **`slugify`**: Callable to generate anchors.
Default: `markdown.extensions.headerid.slugify`
diff --git a/docs/extensions/smarty.txt b/docs/extensions/smarty.txt
index 3cef11a..b96b82e 100644
--- a/docs/extensions/smarty.txt
+++ b/docs/extensions/smarty.txt
@@ -13,13 +13,25 @@ Summary
The SmartyPants extension converts ASCII dashes, quotes and ellipses to
their HTML entity equivalents.
-ASCII symbol | Unicode replacements
------------- | --------------------
-&#39; | &lsquo; &rsquo;
-&quot; | &ldquo; &rdquo;
-\... | &hellip;
-\-- | &ndash;
--\-- | &mdash;
+ASCII symbol | Replacements | HTML Entities
+------------ | --------------- | -------------------
+&#39; | &lsquo; &rsquo; | `&lsquo;` `&rsquo;`
+&quot; | &ldquo; &rdquo; | `&ldquo;` `&rdquo;`
+\... | &hellip; | `&hellip;`
+\-- | &ndash; | `&ndash;`
+-\-- | &mdash; | `&mdash;`
+
+!!! note
+ This extension reimplements the Python [SmartyPants]
+ library by intregated it into the markdown parser.
+ While this does not provide any additional features,
+ it does offer a few advantages. Notably, it will not
+ try to work on highlighted code blocks (using the
+ [CodeHilite] Extension) like the third party library
+ has been known to do.
+
+[SmartyPants]: http://pythonhosted.org/smartypants/
+[CodeHilite]: code_hilite.html
Usage
-----
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt
index d13aadb..4d2d3c0 100644
--- a/docs/extensions/toc.txt
+++ b/docs/extensions/toc.txt
@@ -52,7 +52,7 @@ configuring extensions.
The following options are provided to configure the output:
-* **marker**:
+* **`marker`**:
Text to find and replace with the Table of Contents. Defaults
to `[TOC]`.
@@ -69,20 +69,20 @@ The following options are provided to configure the output:
>>> html = md.convert(text)
>>> render_some_template(context={'body': html, 'toc': md.toc})
-* **slugify**:
+* **`slugify`**:
Callable to generate anchors based on header text. Defaults to a built in
`slugify` method. The callable must accept one argument which contains the
text content of the header and return a string which will be used as the
anchor text.
-* **title**:
+* **`title`**:
Title to insert in the Table of Contents' `<div>`. Defaults to `None`.
-* **anchorlink**:
+* **`anchorlink`**:
Setting to `True` will cause the headers link to themselves. Default is
`False`.
-* **permalink**:
+* **`permalink`**:
Set to `True` to have this extension generate a Sphinx-style permanent links
near the headers (for use with Sphinx stylesheets).
diff --git a/docs/extensions/wikilinks.txt b/docs/extensions/wikilinks.txt
index ea694a8..795ebb4 100644
--- a/docs/extensions/wikilinks.txt
+++ b/docs/extensions/wikilinks.txt
@@ -58,19 +58,19 @@ the html class `wikilink`.
The following options are provided to change the default behavior:
-* **base_url**: String to append to beginning of URL.
+* **`base_url`**: String to append to beginning of URL.
Default: `'/'`
-* **end_url**: String to append to end of URL.
+* **`end_url`**: String to append to end of URL.
Default: `'/'`
-* **html_class**: CSS class. Leave blank for none.
+* **`html_class`**: CSS class. Leave blank for none.
Default: `'wikilink'`
-* **build_url**: Callable which formats the URL from its parts.
+* **`build_url`**: Callable which formats the URL from its parts.
### Examples ###
id='n708' href='#n708'>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