commit | 54d55782459521e7f549043e1dc3370af79ee154 | [log] [tgz] |
---|---|---|
author | Juan Jose Alonso <kernel.no.found@gmail.com> | Tue Oct 04 23:36:51 2011 +0200 |
committer | Michael Brooks <michael@michaelbrooks.ca> | Tue Oct 04 15:44:41 2011 -0700 |
tree | 70edce9b9d92a00a6553ac1993951e5ce6f7966a | |
parent | 300e8e4671984642c8537f0de15bec99b82ca112 [diff] |
Add template/docs/es/ and minors fixes at docs/es/1.0.0/index.md
The JavaScript API documentation for PhoneGap.
The documentation is available on 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/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 GitHub Issues
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 phonegap:master
Do you want the PhoneGap 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, PhoneGap-Docs uses a Ruby script and joDoc to generate 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
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