A documentation tool for TypeScript Definition files
Haskell CSS
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
examples
src
.gitignore
LICENSE
README.md
Setup.lhs Initial commit Sep 26, 2013
cabal.config
typescript-docs.cabal Bump cmdtheline dependency, add cabal config Jan 16, 2015

README.md

Features

  • Hyperlink generation
  • Basic module support
  • Support for simple jsdoc-style comments

Installation

First install the Haskell Platform.

Now install the typescript-docs package:

cabal install typescript-docs

Alternatively, clone and build locally:

git clone git@github.com:paf31/typescript-docs.git
cd typescript-docs
cabal install

Usage

Generate declaration files as part of your build:

tsc -d ...

Include comments:

tsc -d -c ...

Run typescript-docs

typescript-docs *.d.ts

Getting Help

typescript-docs --help

Styling

You may wish to style the following classes using css:

  • keyword
  • syntax
  • identifier
  • literal
  • mono