commit | 226978e26b0dee6738a85b705f610ecf2a6c5bcd | [log] [tgz] |
---|---|---|
author | Becky Gibson <gibson.becky@gmail.com> | Thu Jun 23 02:12:58 2011 +0800 |
committer | Becky Gibson <gibson.becky@gmail.com> | Thu Jun 23 02:42:16 2011 +0800 |
tree | 87fa68ae27eb0050a33ac2b4ecf6b71200e4b422 | |
parent | 21f2071e709aa99459c2fb4c9c3650a38d784aaa [diff] |
Updated Capture docs for iOS support.
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