@eeue56/geiriadur

geiriadur

An Elm-style documentation generator for TypeScript. It uses a markdown file to document exposed types and functions, along with their type signature and any jsdoc they may have. There is also a link to the source included.

Part of the Hiraeth collection.

Example

export function program<Model, Msg>(program: Program<Model, Msg>) {}

will generate this

Installation

npm install --save @eeue56/geiriadur

Usage

npx @eeue56/geiriadur

will find docs within the current tsconfig.json and generate them in a docs folder. Check out an example here

Name

Geiriadur means dictionary. An English speaker may pronounce it as "gay-rh-ya-dirh".