Skip to content

Commit 5ffbb6f

Browse files
authored
feat(dgeni): process API doc descriptions through markdown (#2961)
1 parent 1858e22 commit 5ffbb6f

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

tools/dgeni/src/processors/markdown.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,14 @@ export class MarkdownCodeProcessor implements Processor {
8181
$runAfter = ['paths-computed'];
8282
$runBefore = ['rendering-docs'];
8383
docTypes = [];
84+
contentKey = 'content';
8485

8586
constructor() {}
8687

8788
$process(docs: Document[]) {
8889
return docs.map((doc) => {
8990
if(this.docTypes.includes(doc.docType)){
90-
doc.content = marked.parse(doc.content);
91+
doc[this.contentKey] = marked.parse(doc.content);
9192
};
9293
return doc;
9394
});

tools/dgeni/src/transforms/daffodil-api-package/index.ts

+6
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import { FilterContainedDocsProcessor } from '../../processors/filterDocs';
1414
import { FilterOutPrivatePropertiesProcessor } from '../../processors/filterOutPrivateProperties';
1515
import { GenerateApiListProcessor } from '../../processors/generateApiList';
1616
import { MakeTypesHtmlCompatibleProcessor } from '../../processors/makeTypesHtmlCompatible';
17+
import { MarkdownCodeProcessor } from '../../processors/markdown';
1718
import { PackagesProcessor } from '../../processors/packages';
1819
import {
1920
API_SOURCE_PATH,
@@ -39,6 +40,7 @@ export const apiDocs = new Package('daffodil-api', [
3940
.processor(new AddLinkTagToDaffodilReferencesProcessor())
4041
.processor(new GenerateApiListProcessor())
4142
.processor(new PackagesProcessor())
43+
.processor(new MarkdownCodeProcessor())
4244
.factory('API_DOC_TYPES_TO_RENDER', (EXPORT_DOC_TYPES) => EXPORT_DOC_TYPES.concat(['component', 'directive', 'pipe', 'package']))
4345
//Configure our package
4446
.config((readFilesProcessor, readTypeScriptModules, tsParser) => {
@@ -59,6 +61,10 @@ export const apiDocs = new Package('daffodil-api', [
5961
DAFF_DGENI_EXCLUDED_PACKAGES_REGEX + '/**/src/index.ts',
6062
];
6163
})
64+
.config((markdown: MarkdownCodeProcessor, EXPORT_DOC_TYPES) => {
65+
markdown.docTypes.push(...EXPORT_DOC_TYPES);
66+
markdown.contentKey = 'description';
67+
})
6268
.config((computePathsProcessor, EXPORT_DOC_TYPES, generateApiList) => {
6369

6470
const API_SEGMENT = DAFF_DOC_KIND_PATH_SEGMENT_MAP[DaffDocKind.API];

0 commit comments

Comments
 (0)