updateReadme
updateReadme(
readmePath,searchPhrase,repoUrl?,split?):Promise<void>
Defined in: readme-tsdoc.js:630
Update README file with auto-generated TypeScript documentation
Parameters
Section titled “Parameters”readmePath
Section titled “readmePath”string
Path to the README file to update
searchPhrase
Section titled “searchPhrase”string
The phrase to search for in the README to mark sections for auto-generation
repoUrl?
Section titled “repoUrl?”string
Optional repository URL for generating deep links (e.g., ‘https://github.com/vanviegen/readme-tsdoc’)
split?
Section titled “split?”boolean
When true, generate split documentation with brief overview in main file and details in separate files
Returns
Section titled “Returns”Promise<void>