Expand description
Split Markdown, reStructuredText and plain text into heading-scoped sections small enough to rank and quote.
Structs§
Functions§
- clean_
mdx - Blank out front matter (keeping its
title), and for MDX theimport/exportlines and JSX-only lines.export const title = "..."names the page andexport const descriptionkeeps its text. HTML headings (<h3 id="x"><a href="#x">@import</a></h3>, one or more lines) become Markdown headings so sections split at them. Line numbers are preserved. - generic_
heading - Headings that name a part of a page, not a topic (
Parameters,Returns,Examples): the topic is the heading above them. - metadata_
body - The body of a Python METADATA file (after the RFC 822 headers), which is the package README.
- split
- topic_
heading - The heading an entry is about: its last heading, or the one above it
when the last is generic (
generateMetadata › Parameters->generateMetadata).