@zigen/esdoc

    1.0.1 • Public • Published

    Build Status Coverage Status Document

    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

    # move to a your project directory 
    cd your-project/
     
    # install ESDoc and standard plugin 
    npm install esdoc esdoc-standard-plugin
     
    # write a configuration file. 
    echo '{
      "source": "./src",
      "destination": "./docs",
      "plugins": [{"name": "esdoc-standard-plugin"}]
    }' > .esdoc.json
     
    # run ESDoc 
    ./node_modules/.bin/esdoc
     
    # see a documentation 
    open ./docs/index.html

    Document

    please visit esdoc.org to see more documentation.

    License

    MIT

    Author

    Ryo Maruyama@h13i32maru

    Install

    npm i @zigen/esdoc

    Homepage

    esdoc.org/

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • zigen