typedoc-plugin-markdown
Version:
A TypeDoc plugin that generates TypeScript API documentation as Markdown.
16 lines (15 loc) • 730 B
TypeScript
/**
* Reverses the markdown the theme adds when rendering a type, so the result can
* be shown as plain code (e.g. inside a code block):
*
* - Code spans keep their content verbatim. Code spans are literal markdown, so
* the theme never escapes inside them, and their content must not be altered.
* - Links (`[text](url)`) are reduced to their text.
* - Backslash escapes are undone (`\\<` to `<`, `\\\\` to `\\`).
* - Unescaped `*` (bold and italic markers) are removed.
* - `<` and `>` (from `useHTMLEncodedBrackets`) are decoded.
*
* The string is read once from left to right, so content produced by one rule
* is never rewritten by another.
*/
export declare function unEscapeChars(str: string): string;