0.1.4 • Published 6 years ago
docfx-project v0.1.4
docfx-project
A NodeJS library for working with DocFX projects and their content.
const project: DocFXProject = await DocFXProject.load('./docs/docfx.json');
const contentFiles: string[] = await project.getContentFiles('.md', '.yml');
const topics: TopicMetadata[] = await project.getTopics();
const progressSubject = new Rx.Subject<string>(
message => console.log(message),
error => console.log(error)
);
const topicsWithProgress: TopicMetadata[] = await project.getTopics(progressSubject);
Known issues
Currently, this only supports extracting topic metadata from conceptual (.md
) and managed reference (.yml
) files; does not support extracting topics from Swagger (.json
) files.