檢視原始碼 edoc_doclet_markdown (edoc v1.3.2)

Doclet 將 edoc 應用程式轉換為使用 EEP-59 和 Markdown。

這個 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 的主要進入點。

函式

-spec run(edoc_doclet:command(), edoc_doclet:context()) -> ok.

Doclet 的主要進入點。

此 doclet 與 edoc_layout_chunks 緊密耦合,應與之一起使用。