View Source edown_layout (edown v0.9.2)

Markdown layout module for EDoc. Derived from edoc_layout, which is part of the Erlang/OTP application EDoc. The module is intended to be used together with edoc.

Summary

Functions

markdown(Title, CSS, Body)

module(Element, Options)

The layout function.

overview(E, Options)

package(E, Options)

type(E)

Functions

markdown(Title, CSS, Body)

module(Element, Options)

The layout function.

Options to the standard layout:

{index_columns, integer()}: Specifies the number of column pairs used for the function index tables. The default value is 1.
{pretty_printer, atom()}: Specifies how types and specifications are pretty printed. If the value erl_pp is specified the Erlang pretty printer (the module erl_pp) will be used. The default is to do no pretty printing which implies that lines can be very long.
{stylesheet, string()}: Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css". If an empty string is specified, no stylesheet reference will be generated.
{sort_functions, boolean()}: If true, 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 true.
{xml_export, Module::atom()}: Specifies an xmerl callback module to be used for exporting the documentation. See xmerl:export_simple_content/2 for details.

See also: //edoc/edoc:layout/2.