查看源码 edoc_doclet_markdown (edoc v1.3.2)

将 edoc 应用转换为使用 EEP-59 和 Markdown 的 Doclet。

此 Doclet 必须与 edoc_layout_chunks 一起使用。

示例

 1> edoc:application(example, [{preprocess, true}, {doclet, edoc_doclet_markdown},
       {layout, edoc_layout_chunks}]).

它会将概述转换为 Markdown,并将任何模块文档转换为使用 -doc 属性和 Markdown。edoc 文档中任何不属于 Erlang 文档格式支持的标签的 XHTML 标签都将作为 HTML 标签添加到 Markdown 中。

它不会删除旧的 edoc 文档。

另请参阅:edoc_layout_chunks

摘要

函数

主要的 doclet 入口点。

函数

链接到此函数

run(Doclet_gen, Ctxt)

查看源码
-spec run(edoc_doclet:command(), edoc_doclet:context()) -> ok.

主要的 doclet 入口点。

此 doclet 与 edoc_layout_chunks 紧密耦合,应与它一起使用。