blob: fa54d3c7070067c456bfb9045e01d58bc5447ab0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
Abbreviations
-------------
Summary
-------
The Markdown Abbreviation Extension adds the ability to define abbreviations.
Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.
The Abbreviation extension is included in the standard Markdown library.
Syntax
------
Abbreviations are defined using the syntax established in
[PHP Markdown Extra][php].
[php]: http://www.michelf.com/projects/php-markdown/extra/#abbr
Thus, the following text (taken from the above referenced PHP documentation):
The HTML specification
is maintained by the W3C.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
will be rendered like so:
<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
Usage
-----
From the Python interpreter:
>>> import markdown
>>> text = """
... Some text with an ABBR.
...
... *[ABBR]: Abbreviation
... """
>>> html = markdown.markdown(text, ['abbr'])
To use with other extensions, just add them to the list, like this:
>>> html = markdown.markdown(text, ['abbr', 'footnotes'])
Abbreviations can also be called from the command line using Markdown's `-x`
parameter, like so:
markdown.py -x abbr source.txt > output.html
|
