@types/docdown

Installation

npm install --save @types/docdown

Summary

This package contains type definitions for docdown (https://github.com/jdalton/docdown#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/docdown.

index.d.ts

/**
 * A simple JSDoc to Markdown documentation generator.
 * Generates Markdown documentation based on JSDoc comments.
 */
declare function docdown(options: docdown.Options): string;

declare namespace docdown {
    interface Options {
        /**
         * the input file pat
         */
        path: string;
        /**
         * The source URL.
         */
        url: string;
        /**
         *  The language indicator for code blocks.
         * @default 'js'
         */
        lang?: string | undefined;
        /**
         * Specify whether entries are sorted.
         * @default true
         */
        sort?: boolean | undefined;
        /**
         * The hash style for links ('default' or 'github').
         * @default 'default'
         */
        style?: string | undefined;
        /**
         * The documentation title.
         * @default '<%= basename(options.path) %> API documentation'
         */
        title?: string | undefined;
        /**
         * The table of contents organization style ('categories' or 'properties').
         * @default 'properties'
         */
        toc?: string | undefined;
    }
}

export = docdown;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: none

Credits

These definitions were written by Piotr Błażejewicz.