@coralproject/tstdoc

This projects serves to provide a way to document Typescript interfaces in Markdown.

Installation

yarn add -D @coralproject/tstdoc

# OR

npm install -D @coralproject/tstdoc

CLI

# This is actually used to generate the documentation below!
tstdoc README.md

API

import generate from "@coralproject/tstdoc";

// ...

const documentation = await generate(options);

Options

Below is the documentation for the options passed into generate for programmably creating documentation.

Parameters

fileName (string)

fileName is the file that contains the typescript type that you want to generate documentation for.

indent (number)

indent is the number of header characters to start each header with (minimum 1).

symbolNames (array)

symbolNames are the symbols in the file that you want to generate documentation for.

License

This project is released under the Apache License, v2.0.