Neologistic Paraphasic Mumbling
    Have ideas to improve npm?Join in the discussion! »

    docme

    0.3.0 • Public • Published

    docme build status

    Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.

    Installation

    npm install docme
    

    Usage

    docme <readme> <docme-options> -- <jsdoc-options>
    
      Generates jsdocs for non-private members of the project in the current folder.
      It then updates the given README with the githubified version of the generated API docs.
    
      Note: overriding the jsdoc destination (-d, --destination) is not possible since docme will write files to a temp dir
    
    OPTIONS:
    
      -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
      
      -h, --help      Print this help message.
    
    EXAMPLES:
      
      Generate with default options and update README.md
        
        docme README.md
    
      Override [jsdocconf.json](http://usejsdoc.org/about-configuring-jsdoc.html):
    
        docme README.md -- --configure ./myconf.json
    
      Override loglevel and jsoc configuration:
    
        docme API.md --loglevel silly -- --configure ./myconf.json
    

    Note: all functions that are not part of the public API should be marked as @private in order to exclude them from the docs generated by docme.

    Helpful links

    Since docme is using jsdoc under the hood, it is helpful to review its documentation. I highly recommend this page explaining how to specify @param types among other useful specs.

    In order to make your docme APIs appear properly styled, please install the chrome extension or bookmarklet.

    API

    docme(readme, args, jsdocargs, cb)

    Generates jsdocs for non-private members of the project in the current folder. It then updates the given README with the githubified version of the generated API docs.

    Parameters:
    Name Type Description
    readme String

    path to readme in which the API docs should be updated

    args Array.<String>

    consumed by docme

    Properties
    Name Type Argument Description
    loglevel String <optional>

    (info) level at which to log: silly|verbose|info|warn|error|silent

    jsdocargs Array.<String>

    consumed by jsdoc

    cb function

    called back when docme finished updating the README

    Source:

    generated with docme

    License

    MIT

    Install

    npm i docme

    DownloadsWeekly Downloads

    5

    Version

    0.3.0

    License

    MIT

    Last publish

    Collaborators

    • avatar