@mui/internal-docs-infra
Version:
MUI Infra - internal documentation creation tools.
35 lines • 830 B
text/typescript
import type { Plugin } from 'unified';
/**
* Remark plugin that cleans up meta link patterns in markdown.
*
* Looks for patterns where a Demo/Types component is followed by a meta link
* (e.g., "[See Demo]", "[See Setup]", "[See Types]") and optionally a horizontal
* rule (---). When found, removes the link and any following horizontal rule.
*
* This is useful for markdown that will be converted to HTML where the link
* and separator are distracting on the page.
*
* Pattern it matches:
* ```
* <DemoSomething />
*
* [See Demo](./demos/base/)
*
* --- (optional)
* ```
*
* Gets transformed to:
* ```
* <DemoSomething />
* ```
*
* Also matches:
* ```
* <TypesSomething />
*
* [See Types](./types.md#something)
*
* --- (optional)
* ```
*/
export declare const transformMarkdownMetaLinks: Plugin;