1MKD-EXTENSIONS(7) BSD Miscellaneous Information Manual MKD-EXTENSIONS(7)
2
4 mkd-extensions — Extensions to the Markdown text formatting syntax
5
7 This version of markdown has been extended in a few ways by extending
8 existing markup, creating new markup from scratch, and borrowing markup
9 from other markup languages.
10 Image dimensions
12 Markdown embedded images have been extended to allow specifying the
13 dimensions of the image by adding a new argument =/height/x/width/ to the
14 link description.
15 The new image syntax is
17 
18 pseudo-protocols
20 Five pseudo-protocols have been added to links
21 id: The alt text is marked up and written to the output, wrapped with
23 <a id=id> and </a>.
24 class:
26 The alt text is marked up and written to the output, wrapped with
27 <span class=class> and </span>.
28 raw: The title is written -- with no further processing -- to the out‐
30 put. The alt text is discarded.
31 abbr: The alt text is marked up and written to the output, wrapped with
33 <abbr title=abbr> and </abbr>.
34 lang: The alt text s marked up and written to the output, wrapped with
36 <span lang=lang> and </span>.
37 Pandoc headers
39 The markdown source document can have a 3-line Pandoc header in the for‐
40 mat of
41 % title
42 % author(s)
43 % date
44 which will be made available to the mkd_doc_title(), mkd_doc_author(),
45 and mkd_doc_date() functions.
46 Definition lists
48 A definition list item is defined as
49 =tag=
50 description
51 (that is a =, followed by text, another =, a newline, 4 spaces of intent,
52 and then more text.)
53 Alternatively, definition list items are defined as
55 tag
56 : description
57 (This is the format that PHP Markdown Extra uses.)
58 embedded stylesheets
60 Stylesheets may be defined and modified in a <style> block. A style
61 block is parsed like any other block level html; <style> starting on col‐
62 umn 1, raw html (or, in this case, css) following it, and either ending
63 with a </style> at the end of the line or a </style> at the beginning of
64 a subsequent line.
65 Be warned that style blocks work like footnote links -- no matter where
67 you define them they are valid for the entire document.
68 alpha lists
70 Alphabetic lists (like regular numeric lists, but with alphabetic items)
71 are supported. So:
72 a. this
73 b. is
74 c. an alphabetic
75 d. list
76 will produce:
77 <ol type=a>
78 <li>this</li>
79 <li>is</li>
80 <li>an alphabetic</li>
81 <li>list</li>
82 </ol>
83 tables
85 PHP Markdown Extra tables are supported; input of the form
86 header|header
87 ------|------
88 text | text
89 will produce:
90 <table>
91 <thead>
92 <tr>
93 <th>header</th>
94 <th>header</th>
95 </tr>
96 </thead>
97 <tbody>
98 <tr>
99 <td>text</td>
100 <td>text</td>
101 </tr>
102 </tbody>
103 </table>
104 The dashed line can also contain : characters for formatting; if a : is
105 at the start of a column, it tells discount to align the cell contents to
106 the left; if it's at the end, it aligns right, and if there's one at the
107 start and at the end, it centers.
108 strikethrough
110 A strikethrough syntax is supported in much the same way that ` is used
111 to define a section of code. If you enclose text with two or more
112 tildes, such as ~~erased text~~ it will be written as <del>erased
113 text</del>. Like code sections, you may use as many ~ as you want, but
114 there must be as many starting tildes as closing tildes.
115 markdown extra-style footnotes
117 PHP Markdown Extra footnotes are supported. If a footnote link begins
118 with a ^, the first use of that footnote will generate a link down to the
119 bottom of the rendered document, which will contain a numbered footnote
120 with a link back to where the footnote was called.
121
123 David Parsons http://www.pell.portland.or.us/~orc/
124
126 markdown(1), markdown(3), mkd-callbacks(3), mkd-functions(3),
127 mkd-line(3).
128 http://daringfireball.net/projects/markdown
130 http://michelf.com/projects/php-markdown
132MASTODON Dec 22, 2007 MASTODON