Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/api-extractor > ExtractorConfig > projectFolderUrl

ExtractorConfig.projectFolderUrl property

The base URL where the project's source code can be viewed on a website such as GitHub or Azure DevOps. This URL path corresponds to the <projectFolder> path on disk.


readonly projectFolderUrl: string | undefined;


This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. For example, if the projectFolderUrl is "" and an API item's file path is "api/ExtractorConfig.ts", the full URL file path would be "".

Can be omitted if you don't need source code links in your API documentation reference.