kontan / dtsdoc Goto Github PK

Hi! @kontan,

I would like to use your dtsdoc in my site to provide online docs to each TypeScript definition (http://www.tsdpm.com). To do it I would like to have a function to get an html code(string) from a TypeScript code(string).

Something like:

...
var code = '...[my typescript code]...';
var html = dtsdoc.toHtml(code);
...

I would like to use this code with nodejs to generate all docs as static pages with my build process. could you help-me?

A suggestion

A good approach can be made with the separation of concerns on your API, like:

                                 API module                            API module
                            +-------------------+                  +-------------------+
                            |                   |                  |                   | 
(input) TypeScript code --> | PARSE TO METADATA | --> metadata --> | TRANSFORM TO HTML | --> html (output)
                            |                   |                  |                   | 
                            +-------------------+                  +-------------------+

with this we will have a parse to metadata module that do not have external dependencies. The transform to html module can't have DOM dependencies, this module only get the metadata to generate html code.

This allows us to create other transformations types with the metadata.

What do you think about this design?

About use your doc generator on my site, could you help-me?

Thank you!

Grunt is a much more robust build system and might prove easier to work with down the road. There's even a nice grunt-typescript plugin.
I'll see if I can convert it and shoot you a pull req.

I found dtsdoc and noticed you once generated docs for many of DefinitelyTyped definition files (on http://phyzkit.net/docs), that is really nice!

I'm a DefinitelyTyped member and am collecting content to create a nice DT organisation website (for the community, on the definitelytyped.github.io page).

Would you be interested in looking into if dtsdoc could work somewhat reliable for recent TS versions and collaborating on this part of the (future) website?

This is still a very preliminary idea but could be a cool side project.

Re: DefinitelyTyped/DefinitelyTyped#1571