https://github.com/eeue56/geiriadur

An Elm-style documentation generator for typescript
https://github.com/eeue56/geiriadur

Last synced: about 2 months ago
JSON representation

An Elm-style documentation generator for typescript

• Host: GitHub
• URL: https://github.com/eeue56/geiriadur
• Owner: eeue56
• License: bsd-3-clause
• Created: 2021-03-30T20:37:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-02T15:22:16.000Z (over 3 years ago)
• Last Synced: 2024-10-31T17:44:54.318Z (3 months ago)
• Language: TypeScript
• Size: 58.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/eeue56/hiraeth) collection.

## Example

```javascript

export function program(program: Program) {}

```

will generate [this](https://github.com/eeue56/coed/blob/main/docs/src/html.md#program)

## 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](https://github.com/eeue56/coed#usage)

## Name

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