type-docs v0.0.4

type-docs

install

npm install --save-dev type-docs

usage

1. in your typescript code, add the special comments:

   // @docstart API/Players/List
   export interface PlayerList {
       players: Player[];
       count: number;
   }
   // @docend

2. in your template markdown file(eg, DOCS.t.md), add the following tempalte code:

   List
   ${API/Player/List}

3. run type-docs -d src/ -t src/DOCS.t.md -o DOCS.md

4. DOCS.md will be generated with the type definitions filled