Page Contents
Home > @loopback/tsdocs > updateApiDocs
updateApiDocs() function
Update markdown files generated by api-documenter to prepend Jekyll metadata and generate apidocs/index.md
.
Signature:
export declare function updateApiDocs(options?: ApiDocsOptions): Promise<void>;
Parameters
Parameter | Type | Description |
---|---|---|
options | ApiDocsOptions | (Optional) Options for api docs |
Returns:
Promise<void>