typedoc-transformer

0.0.1 • Public • Published

typedoc-transformer

Tool for transforming typedoc json to other formats

Usage

Usage for converting to modified JSDoc/JSON API lovechild

1. Generate a config file

See config schema.

{
  "manifest" : {
    "title": "My docs site",
    "intro": "Everything is awesome"
  },
  "projects": [
    {
      "src": "path/to/some/project"
    }
  ],
  "output": "out.json"
}

2. Run transform

tdt my-config.json

Readme

Keywords

none

Package Sidebar

Install

npm i typedoc-transformer

Weekly Downloads

2

Version

0.0.1

License

MIT

Last publish

Collaborators

  • asakusuma