mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 00:15:32 +00:00
661069c0c3
Relates to #10207. Adds @microsoft/api-extractor and @microsoft/api-documenter NPM packages for validating and generating API documentation from Typescript modules. Adds basic configuration for each module that we will be publishing at this time. api-extractor's output will be emitted to /developer/docs/api/etc/, for future release comparisons. A baseline output will be committed separately. The build outputs will be in /developer/build/docs and the intermediate files will be in /developer/build/api. Note that at this time, we will not enable the checks and validations. That is a task for alpha rather than beta. The primary intent at this time is to select a solid, well-supported toolchain for generating the API documentation for kmc.
12 lines
476 B
JSON
12 lines
476 B
JSON
/**
|
|
* Config file for API Extractor. For more info, please visit: https://api-extractor.com
|
|
*/
|
|
{
|
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
"extends": "../../../config/api-extractor.base.json",
|
|
"mainEntryPointFilePath": "<projectFolder>/build/src/index.d.ts",
|
|
"docModel": {
|
|
"enabled": true,
|
|
"projectFolderUrl": "http://github.com/keymanapp/keyman/tree/master/developer/src/kmc-keyboard-info"
|
|
}
|
|
}
|