@chialab/rna-apidoc

Generate api documentation using TypeScript symbols.

Usage no npm install needed!

<script type="module">
  import chialabRnaApidoc from 'https://cdn.skypack.dev/@chialab/rna-apidoc';
</script>

README

RNA logo

RNA Apidoc • Generate api documentation using TypeScript symbols.

NPM

Install

$ npm i @chialab/rna-apidoc -D
$ yarn add @chialab/rna-apidoc -D

Usage

Via import

import { generate } from '@chialab/rna-apidoc';

await generate([
    'path/to/entrypoint.ts',
], 'markdown', 'docs/');

Via cli

$ npm i @chialab/rna @chialab/rna-apidoc -D

apidoc [options] <files...>

Options:
  -O, --output <path>        output dir or file
  -F, --format <string>      the output format (json or markdown)
  -h, --help                 display help for command

License

RNA Apidoc is released under the MIT license.