wrap_in_details_tag

wrap_in_details_tag(details_content: str, *, summary_content: str | None = None, summary_heading_level: int | None = None, is_open: bool = False) → str[source]

Wrap details_content in a html details tag and add summary if summary_content set.

Parameters:

  • details_content (str) – Markdown string that should be displayed when the details are expanded.

  • summary_content (str | None) – Summary test that should be displayed. Defaults to None so the summary is Details.

  • summary_heading_level (int | None) – Level of the heading wrapping the summary if it is not None. Defaults to None.

  • is_open (bool) – Whether or not the details tag should be initially opened. Defaults to False.

Return type:

str