createMarkdownLink.ts

Creates a Markdown link or plain text for documentation tables of contents.

If createAsLink is true, returns a Markdown link with the given display text

and path. If an excerpt is provided, it is appended after a dash. If

createAsLink is false, returns the display text, optionally followed by the

excerpt.

@param {boolean} createAsLink - Whether to create a Markdown link or plain text

@param {string} display - The text to display for the link or plain text

@param {string} path - The path or URL for the Markdown link

@param {string} [excerpt] - Optional excerpt to append after the link or text

@returns {string} The formatted Markdown link or plain text

---

Methods

Not available.

---

Last updated: 2025-09-16T21:51:51.931Z

This file is auto generated. Do not edit manually.*

Back to Index