edoc_html_to_markdown — edoc v1.4.1

Search documentation of edoc

# edoc_html_to_markdown (edoc v1.4.1)

View Source

This module can convert application/html+erlang style documentation to markdown.

# Summary

## Functions

convert_html(Application, Module, Html)

Convert `application/html+erlang` (`shell_docs:chunk_element()`) to Markdown suitable for usage with ExDoc.

# Functions

# convert_html(Application, Module, Html)

    -spec convert_html(Application :: atom(), Module :: module(), Html :: shell_docs:chunk_elements()) ->
                          unicode:chardata().

Convert `application/html+erlang` (`shell_docs:chunk_element()`) to Markdown suitable for usage with ExDoc.

The `Application` and `Module` argument are used to correctly generate links.