Nonsense Placement Mandatory

    jsdoc-to-markdown
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/jsdoc-to-markdown package

    7.1.0 • Public • Published

    view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI Coverage Status js-standard-style

    jsdoc-to-markdown

    Upgraders, please read the release notes

    jsdoc-to-markdown

    Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

    Synopsis

    1. Document your code using valid jsdoc comments.

    /**
     * A quite wonderful function.
     * @param {object} - Privacy gown
     * @param {object} - Security
     * @returns {survival}
     */
    function protection (cloak, dagger) {}

    2. Run a command.

    $ jsdoc2md example.js

    3. Get markdown output.

    ## protection(cloak, dagger) ⇒ <code>survival</code>
    A quite wonderful function.
    
    **Kind**: global function
    
    | Param  | Type                | Description  |
    | ------ | ------------------- | ------------ |
    | cloak  | <code>object</code> | Privacy gown |
    | dagger | <code>object</code> | Security     |
    

    Install

    $ npm install --save-dev jsdoc-to-markdown
    

    See also


    © 2014-21 Lloyd Brookes <75pound@gmail.com>.

    Tested by test-runner.

    Install

    npm i jsdoc-to-markdown

    DownloadsWeekly Downloads

    106,406

    Version

    7.1.0

    License

    MIT

    Unpacked Size

    22.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • 75lb