@flux159/esdoc

    0.5.3 • Public • Published

    Build Status Coverage Status Document Manual

    A fork of ESDoc that uses Less for some styling fixes and also enables manual searching.

    Published via npm as @flux159/esdoc:

    npm install @flux159/esdoc
    

    ESDoc

    ESDoc is a documentation generator for JavaScript.
    Please try it out!

    Features

    • Generates good documentation.
    • Measures documentation coverage.
    • Integrate test codes into documentation.
    • Integrate manual into documentation.
    • Parse ECMAScript proposals.
    • ESDoc Hosting Service

    Users

    And more.

    Quick Start

    # install ESDoc from npm 
    npm install -g esdoc
     
    # move to a your project directory 
    cd your-project/
     
    # write a configuration file. 
    echo '{"source": "./src", "destination": "./doc"}' > .esdoc.json
     
    # run ESDoc 
    esdoc
     
    # see a documentation 
    open ./doc/index.html

    Document

    please visit esdoc.org to see more documentation.

    License

    MIT

    Author

    Ryo Maruyama@h13i32maru

    Install

    npm i @flux159/esdoc

    Homepage

    esdoc.org/

    DownloadsWeekly Downloads

    0

    Version

    0.5.3

    License

    MIT

    Last publish

    Collaborators

    • flux159