edoc_html_to_markdown(3)

πŸ“¦
version 29.0.6 Β· 2 versions
, in ubuntu stonking

✨ edoc_html_to_markdown β€” the Erlang module girly πŸ’–

okay bestie, so this is a page from the Erlang Module Definition section of the manual (volume 3, iykyk), all about the module edoc_html_to_markdown. sit down, hydrate, let's get into it 🫢


🌸 NAME 🌸

edoc_html_to_markdown β€” this module can convert application/html+erlang style documentation to markdown. yes queen, it's literally the glow-up from HTML to Markdown πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

sooo… there is genuinely nothing here. the DESCRIPTION section is empty. not a single crumb. we move on πŸ™ˆ (the real tea is down in FUNCTIONS, keep scrolling)


πŸŽ€ FUNCTIONS πŸŽ€

✨ convert_html ✨

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

Convert application/html+erlang (that's a shell_docs:chunk_element()) to Markdown suitable for usage with ExDoc. glow-up complete ✨

and the Application and Module arguments? they're not just decorative, bestie β€” they are used to correctly generate links. πŸ”— so pass them properly, no cap.

fr fr, this is your little pipeline from Erlang's fancy HTML doc situation straight into ExDoc-compatible Markdown. chef's kiss. πŸ‘‘

that's the whole page, no crumbs left πŸ’œ

signing off with the official receipts: this beauty is brought to you by Ericsson AB, version edoc 1.5, and it lives at edoc_html_to_markdown(3). hope this helped, mwah πŸ˜­πŸ’–

πŸ“¦ where this page comes from