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
|
# Module edown_layout #
* [Description](#description)
* [Function Index](#index)
* [Function Details](#functions)
Markdown layout module for EDoc.
Copyright (c) 2014 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
<a name="description"></a>
## Description ##
Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
The module is intended to be used together with edoc.<a name="index"></a>
## Function Index ##
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#markdown-3">markdown/3</a></td><td></td></tr><tr><td valign="top"><a href="#module-2">module/2</a></td><td>The layout function.</td></tr><tr><td valign="top"><a href="#overview-2">overview/2</a></td><td></td></tr><tr><td valign="top"><a href="#package-2">package/2</a></td><td></td></tr><tr><td valign="top"><a href="#type-1">type/1</a></td><td></td></tr></table>
<a name="functions"></a>
## Function Details ##
<a name="markdown-3"></a>
### markdown/3 ###
`markdown(Title, CSS, Body) -> any()`
<a name="module-2"></a>
### module/2 ###
`module(Element, Options) -> any()`
The layout function.
Options to the standard layout:
<dt><code>{index_columns, integer()}</code>
</dt>
<dd>Specifies the number of column pairs used for the function
index tables. The default value is 1.
</dd>
<dt><code>{pretty_printer, atom()}</code>
</dt>
<dd>Specifies how types and specifications are pretty printed.
If the value <code>erl_pp</code> is specified the Erlang pretty printer
(the module <code>erl_pp</code>) will be used. The default is to do
no pretty printing which implies that lines can be very long.
</dd>
<dt><code>{stylesheet, string()}</code>
</dt>
<dd>Specifies the URI used for referencing the stylesheet. The
default value is <code>"stylesheet.css"</code>. If an empty string is
specified, no stylesheet reference will be generated.
</dd>
<dt><code>{sort_functions, boolean()}</code>
</dt>
<dd>If <code>true</code>, the detailed function descriptions are listed by
name, otherwise they are listed in the order of occurrence in
the source file. The default value is <code>true</code>.
</dd>
<dt><code>{xml_export, Module::atom()}</code>
</dt>
<dd>Specifies an <a href="http://www.erlang.org/doc/man/index.html" target="_top"><code>xmerl</code></a> callback module to be
used for exporting the documentation. See <a href="http://www.erlang.org/doc/man/xmerl.html#export_simple_content-2"><code>//xmerl/xmerl:export_simple_content/2</code></a> for details.
</dd>
__See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).
<a name="overview-2"></a>
### overview/2 ###
`overview(E, Options) -> any()`
<a name="package-2"></a>
### package/2 ###
`package(E, Options) -> any()`
<a name="type-1"></a>
### type/1 ###
`type(E) -> any()`
|
