Typedoc: What is json option?

Created on 19 Jul 2016 · 15Comments · Source: TypeStrong/typedoc

Hi, is there more information about the json option and the outputed json file? How can I use it to generate documentation?

question

Source

iveetoo

Most helpful comment

Is there a definition (e.g. d.ts declaration) that serves as a schema for the generated file? I'm interested in creating a tool in Typescript that consumes this output, but the generated JSON is a monster of a file.

EDIT:
Either that or a format that is easier to consume...

sergiusignacius on 4 Aug 2016

👍3

All 15 comments

I believe the json option allows you to serialize your parsed project documentation to a file. I think the idea is to use the parsed documentation in other tools.

aciccarello on 19 Jul 2016

Can you give me an example of such tool, that consumes json and produces documentation?

iveetoo on 22 Jul 2016

I'm not sure who's using it right now.

aciccarello on 22 Jul 2016

We used the JSON output to create UML Diagrams in GenMyModel. Transpile the JSON output to XMI 2.1 (UML Structured in XML format) and then import that into GenMyModel. Creating the transpiler was a pain due to the limited documentation but we succeeded. Thanks to @Gronke!

FlippieCoetser on 22 Jul 2016

👍2

EDIT:
Either that or a format that is easier to consume...

sergiusignacius on 4 Aug 2016

👍3

I would like the option of generating a JSON file that my app can consume. I would also like the ability to stop generating HTML files in this case.

ericjim on 15 Nov 2016

@sergiusignacius While it's not perfect, I usually find GenSON helpful in situations like that.

ssokolow on 14 Mar 2017

👍1

@FlippieCoetser did you have your code for conversion from json to XMI out somewhere? That would be pretty useful.

Tiberriver256 on 12 Oct 2017

@Tiberriver256 @gronke and I are just checking if any private info is contained in the code. Once done we will post the link to the code here. When we developed the transpiler typescript was still at an older level which means some of the new features are not covered. but at least you will be able to see the approach we took.

FlippieCoetser on 13 Oct 2017

@Tiberriver256 this is the repo for the code. https://github.com/gronke/TypeDoc-GenMyModel-Transpiler
@gronke will open source the code shortly.

FlippieCoetser on 13 Oct 2017

👍1

@FlippieCoetser the link to the repo is broken. Did you open it?
Would also love to see it.
Thanks!

danbars on 13 Nov 2017

@danbars @gronke will open the package. We removed all privacy info. so it is ready to go. A lot has changed since we last used the transpiler. but it might still give you a direction to work from.

FlippieCoetser on 13 Nov 2017

@danbars @Tiberriver256 there you go: gronke/TypeDoc-GenMyModel-Transpiler