The JavaScript API documentation for Apache Cordova.
The documentation is available on PhoneGap API Documentation website.
All of the Apache Cordova documentation is written with markdown, a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document Cordova's core API and platform-specific APIs.
docs/
docs/LANGUAGE
docs/LANGUAGE/VERSION
docs/LANGUAGE/VERSION/phonegap/
docs/LANGUAGE/VERSION/phonegap/PLUGIN/
docs/LANGUAGE/VERSION/phonegap/PLUGIN/className.md
docs/LANGUAGE/VERSION/phonegap/PLUGIN/className.functionName.md
We use Apache JIRA
By the way, you rock! Thanks for helping us improve the documentation!
Are you new to Git or contributing on GitHub?
We have written a few Git tutorials to help you get started with contributing to the documentation.
Pull requests are welcome!
We appreciate the use of topic branches.
git checkout -b issue_23
# code
git commit -m "Issue 23: Fix a bad bug."
git push origin issue_23
# send pull request from branch issue_23 to cordova:master
Do you want the Apache Cordova documentation in another language? We do too!
1. Create the language directory
# Spanish
mkdir docs/es
2. Add a version
Start with the latest stable release. You can always add other versions later.
mkdir docs/es/1.0.0
3. Begin Translating
Currently, English is the most up-to-date and so it is easiest to copy each English file into the new language directory.
4. config.json
For each version, there is a config.json
that defines the name of the language and
how to merge the files.
5. Customizing HTML template
Each language can override the default template in template/docs/LANGUAGE
.
Currently, a Ruby script and joDoc are used to generate the HTML documentation.
-
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
-
Install json (Ruby JSON parser)
gem install json
./bin/generate
Install rspec:
gem install rspec --version 1.3.0
Run all specs:
rake
Run a specific spec:
spec spec/phonegap/add_title_spec.rb
There is a Rake task to increment the version, generate the version directory, and update the edge documentation.
# generate version 1.7.0
rake version[1.7.0]