generateMarkdownDoc
generateMarkdownDoc(
filePath,headingPrefix,repoUrl?):Promise<string>
Defined in: readme-tsdoc.js:24
Generate markdown documentation for a TypeScript file using TypeScript compiler API
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Path to the TypeScript file
headingPrefix
Section titled “headingPrefix”string
The heading prefix to use (e.g., ’###’ for level 3)
repoUrl?
Section titled “repoUrl?”string
Optional repository URL for generating deep links (e.g., ‘https://github.com/vanviegen/readme-tsdoc’)
Returns
Section titled “Returns”Promise<string>
Generated markdown documentation