@hitomihiumi/micro-docgen v0.3.0

micro-docgen (Forked)

TypeScript documentation generator on steroids 💉. MicroDocgen is built on top of typedoc to leverage its power and add more features.

Link to the original repository

Installation

$ npm install @hitomihiumi/micro-docgen

Usage

import { createDocumentation } from '@hitomihiumi/micro-docgen';
import { name, version } from './package.json'; 
/* 
    ^
    | --- To use this, make sure you have the “resolveJsonModule” flag set to “true” inside your tsconfig.json
*/

await createDocumentation({
    // project name
    name,
    // project version
    version,
    // source files
    input: ['src'],
    // output directory
    output: 'docs',
    // tsconfig path
    tsconfigPath: './tsconfig.json',
    // to generate markdown files
    markdown: true,
    // to generate json file
    jsonName: 'docs.json',
    // include custom files such as readme
    custom: [...]
});