# docfx-project

> Utilities for working with DocFX projects.

Latest version **0.1.4** (published 2018-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install docfx-project
pnpm add docfx-project
yarn add docfx-project
bun add docfx-project
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2018-07-23 |
| First published | 2017-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | tintoy |
| Maintainers | tintoy |

## Links

- npm: https://www.npmjs.com/package/docfx-project
- Repository: https://github.com/tintoy/docfx-project
- Homepage: https://github.com/tintoy/docfx-project#readme
- Issues: https://github.com/tintoy/docfx-project/issues
- npm.io page: https://npm.io/package/docfx-project

## Dependencies (8)

- [mz](https://npm.io/package/mz.md) ^2.6.0
- [glob](https://npm.io/package/glob.md) ^7.1.2
- [rxjs](https://npm.io/package/rxjs.md) ^5.4.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.9.1
- [chokidar](https://npm.io/package/chokidar.md) ^1.7.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [yaml-front-matter](https://npm.io/package/yaml-front-matter.md) ^3.4.0

## Recent versions

- 0.1.4 (latest) — 2018-07-23
- 0.1.3 — 2017-08-17
- 0.1.2 — 2017-08-10
- 0.1.1 — 2017-08-10
- 0.1.0 — 2017-08-10
- 0.0.9 — 2017-08-10
- 0.0.8 — 2017-08-09
- 0.0.7 — 2017-08-08
- 0.0.6 — 2017-08-08
- 0.0.5 — 2017-08-08
- 0.0.4 — 2017-08-08
- 0.0.3 — 2017-08-08
- 0.0.2 — 2017-08-08
- 0.0.1 — 2017-08-08

## README

# docfx-project

A NodeJS library for working with DocFX projects and their content.

```typescript
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.

---
_Source: https://npm.io/package/docfx-project · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._