blob: 195134731a9dc941cf098cc1e9fee5fad953a597 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
title: Attribute Lists Extension
prev_title: Abbreviations Extension
prev_url: abbreviations.html
next_title: Definition Lists Extension
next_url: definition_lists.html
Attribute Lists
===============
Summary
-------
The Attribute Lists extension adds a syntax to define attributes on the various
HTML elements in markdown's output.
This extension is included in the standard Markdown library.
Syntax
------
The basic syntax was inspired by [Maruku][]'s Attribute Lists feature.
[Maruku]: http://maruku.rubyforge.org/proposal.html#attribute_lists
### The List ###
An example attribute list might look like this:
{: #someid .someclass somekey='some value' }
A word which starts with a hash (`#`) will set the id of an element.
A word which starts with a dot (`.`) will be added to the list of classes
assigned to an element.
A key/value pair (`somekey='some value'`) will assign that pair to the element.
Be aware that while the dot syntax will add to a class, using key/value pairs
will always override the previously defined attribute. Consider the following:
{: #id1 .class1 id=id2 class="class2 class3" .class4 }
The above example would result in the following attributes being defined:
id="id2" class="class2 class3 class4"
### Block Level ###
To define attributes for a block level element, the attribute list should
be defined on the last line of the block by itself.
This is a paragraph.
{: #an_id .a_class }
The above results in the following output:
<p id="an_id" class="a_class">This is a paragraph.</p>
The one exception is headers, as they are only ever allowed on one line.
A setext style header {: #setext}
=================================
### A hash style header ### {: #hash }
The above results in the following output:
<h1 id="setext">A setext style header</h1>
<h3 id="hash">A hash style header</h3>
### Inline ###
To define attributes on inline elements, the attribute list should be defined
immediately after the inline element with no white space.
[link](http://example.com){: class="foo bar" title="Some title!" }
The above results in the following output:
<p><a href="http://example.com" class="foo bar" title="Some title!">link</a></p>
Usage
-----
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.attr_list`
as the name of the extension.
This extension does not accept any special configuration options.
|
