The public API documentation for PhoneGap. The documentation is rendered as the PhoneGap API Documentation website.

All of the PhoneGap documentation is written with markdown, a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document PhoneGap's core API and platform-specific APIs.

docs/
docs/phonegap/
docs/phonegap/class_name/
docs/phonegap/class_name/class_name.md
docs/phonegap/class_name/class_name.method_name.md

Currently, PhoneGap-Docs uses joDoc to generate HTML documentation from the set of Markdown files.

• Clone joDoc

    git clone http://github.com/davebalmer/joDoc.git
  

• Add joDoc/ to your path

  Open ~/.bashrc or ~/.profile (or whatever you use)

    export PATH=$PATH:~/path/to/joDoc/
  

• Install markdown

    # Use your package manager
    brew install markdown
    port install markdown
    aptitude install markdown
  

• Install nokogiri (Ruby HTML parser)

    gem install nokogiri
  

cd phonegap-docs
./bin/phonegap-docs

Install rspec:

gem install rspec

Run all specs:

cd phonegap-docs
rake

Run a specific spec:

cd phonegap-docs
spec spec/phonegap/add_title_spec.rb