A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.
Switch branches/tags
Clone or download
Latest commit eed5ab0 Oct 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src add reference for type alias Sep 17, 2018
test
.gitignore
.npmignore add npm ignore Mar 23, 2018
LICENSE Initial commit Aug 25, 2017
README.md
gulpfile.js add tslint Aug 25, 2017
package-lock.json 0.9.112 Sep 17, 2018
package.json 0.9.112 Sep 17, 2018
tsconfig.json change lib to es6 Jun 12, 2018
tslint.json add tslint Aug 25, 2017

README.md

Type2DocFx

A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.

Installation

Type2DocFx runs on Node.js and is available as an NPM package.

$ npm install type2docfx --save-dev

Usage

  Usage: type2docfx [options] <inputFile> <outputFolder>

  A tool to convert the json format api file generated by TypeDoc to yaml format output files for docfx.


  Options:

    -V, --version           output the version number
    --hasModule             Add the option if the source repository contains module
    --disableAlphabetOrder  Add the option if you want to disable the alphabet order in output yaml
    -h, --help              output usage information

License

Licensed under the Apache License 2.0.