commit | a5c17debf6054dd82a052c8f78f1c29230241cc1 | [log] [tgz] |
---|---|---|
author | shazron <shazron@gmail.com> | Mon Jul 18 16:11:11 2011 -0700 |
committer | shazron <shazron@gmail.com> | Mon Jul 18 16:11:11 2011 -0700 |
tree | 1daddcfedce1d65387c737388d6506fd8d5a64ba | |
parent | d7d1a9ab3a141b2825904f75990f958efd2d4afe [diff] |
Fixes #82 Remove Network section (Network.isReachable) doc
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 --version 1.3.0
Run all specs:
cd phonegap-docs rake
Run a specific spec:
cd phonegap-docs spec spec/phonegap/add_title_spec.rb