rustdoc::html::markdown

Function plain_text_summary

Source
pub(crate) fn plain_text_summary(
    md: &str,
    link_names: &[RenderedLink],
) -> String
Expand description

Renders the first paragraph of the provided markdown as plain text. Useful for alt-text.

  • Headings, links, and formatting are stripped.
  • Inline code is rendered as-is, surrounded by backticks.
  • HTML and code blocks are ignored.