-
Notifications
You must be signed in to change notification settings - Fork 681
Expand file tree
/
Copy pathMarkdownAction.ts
More file actions
29 lines (25 loc) · 1.05 KB
/
MarkdownAction.ts
File metadata and controls
29 lines (25 loc) · 1.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine.ts';
import { BaseAction } from './BaseAction.ts';
import { MarkdownDocumenter } from '../documenters/MarkdownDocumenter.ts';
export class MarkdownAction extends BaseAction {
public constructor(parser: ApiDocumenterCommandLine) {
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.'
});
}
protected override async onExecuteAsync(): Promise<void> {
const { apiModel, outputFolder } = this.buildApiModel();
const markdownDocumenter: MarkdownDocumenter = new MarkdownDocumenter({
apiModel,
documenterConfig: undefined,
outputFolder
});
markdownDocumenter.generateFiles();
}
}