@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
24 lines • 1.01 kB
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { BaseAction } from './BaseAction';
import { MarkdownDocumenter } from '../documenters/MarkdownDocumenter';
export class MarkdownAction extends 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 onExecuteAsync() {
const { apiModel, outputFolder } = this.buildApiModel();
const markdownDocumenter = new MarkdownDocumenter({
apiModel,
documenterConfig: undefined,
outputFolder
});
markdownDocumenter.generateFiles();
}
}
//# sourceMappingURL=MarkdownAction.js.map