@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
29 lines • 1.21 kB
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
Object.defineProperty(exports, "__esModule", { value: true });
exports.MarkdownAction = void 0;
const BaseAction_1 = require("./BaseAction");
const MarkdownDocumenter_1 = require("../documenters/MarkdownDocumenter");
class MarkdownAction extends BaseAction_1.BaseAction {
constructor(parser) {
super({
actionName: 'markdown',
summary: 'Generate documentation as Markdown files (*.md)',
documentation: 'Generates API documentation as a collection of files in' +
' Markdown format, suitable for example for publishing on a GitHub site.'
});
}
async onExecute() {
// override
const { apiModel, outputFolder } = this.buildApiModel();
const markdownDocumenter = new MarkdownDocumenter_1.MarkdownDocumenter({
apiModel,
documenterConfig: undefined,
outputFolder
});
markdownDocumenter.generateFiles();
}
}
exports.MarkdownAction = MarkdownAction;
//# sourceMappingURL=MarkdownAction.js.map
;