View Source PhoenixStorybook.Stories.Doc (phoenix_storybook v0.8.1)

Functions to fetch component documentation and render it at HTML.

Summary

Functions

fetch_component_doc(atom, module)

fetch_doc_as_html(story, stripped? \\ true)

Fetch component documentation from component source and format it as HTML.

  • For a live_component, fetches @moduledoc content
  • For a function component, fetches @doc content of the relevant function

Output HTML is splitted in paragraphs and returned as a list of paragraphs.

strip_lv_attributes_doc(doc)

strip_lv_slots_doc(doc)