Numerous Packages Multiply
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    jsdoc-to-markdownpublic

    view on npm npm module downloads Build Status Coverage Status Dependency Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

    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 -g jsdoc-to-markdown
    

    See also


    © 2014-18 Lloyd Brookes 75pound@gmail.com.

    install

    npm i jsdoc-to-markdown

    Downloadsweekly downloads

    15,459

    version

    4.0.1

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar