| commit | 3190b9687a497b9cf929c7eeed35f571b179710f | [log] [tgz] |
|---|---|---|
| author | macdonst <simon.macdonald@gmail.com> | Fri Apr 29 10:50:47 2011 +0800 |
| committer | macdonst <simon.macdonald@gmail.com> | Sat Apr 30 02:12:23 2011 +0800 |
| tree | 0ba25990e539d721e87c50210ae345db92b2bbea | |
| parent | 08c810ad846e491e6ab6c51db327cb2631205f76 [diff] |
Adding event docs for pause/resume
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