Skip to content

jllaneza/doc-gen-ts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc-gen-ts

A sample project using Typescript API that reads the .ts file(s) to extract information that might be useful for automating the documentation. As of now, it produces plain .json file(s).

Getting Started

Installation

$ npm install

Generate documentation

$ npm run build

Project structure

.
├── components              # Contains the .ts file(s) wherein the information for the documentation will be extracted
├── docs                    # Documentation files generated from running `npm run build`
├── src                     # Source files
├── index.ts                # Entry point
└── README.md

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published