|author||Steve Gill <email@example.com>||Tue May 12 15:59:25 2015 -0700|
|committer||Steve Gill <firstname.lastname@example.org>||Tue May 12 15:59:25 2015 -0700|
Added 5.0.0 for russion docs
The documentation is available at docs.cordova.io.
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/cordova/ docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
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! With the support of Crowdin, a translation and localization management platform, translators can login to the easy-to-use tooling and provide as much or as little translation assistance as they would like. If you know another language please support Cordova and contribute. http://crowdin.net/project/cordova. For some best practices for using the Crowdin tool please see our wiki http://wiki.apache.org/cordova/CordovaTranslations.
Cordova language administrators, don't forget these steps:
For each language and version, there is a
config.json that defines the name of the language and how to merge the files.
2. Customizing HTML template
Each language can override the default template in
Please see the
STYLESHEET.md file for guidelines on language and usage.
Right now documentation could be run using Node.js either on Windows, or on Linux box.
$ rm -r tmp public # Clear out old docs $ ./bin/genjs # compile all docs $ ./bin/genjs en edge # compile English Edge docs $ ./bin/genjs ru edge # compile Russian Edge docs $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
Go to Node.JS downloads page
Download and install package for your operation system.
Checkout this repository using Git
git clone https://github.com/apache/cordova-docs
Install dependencies. In the root of the cloned cordova-docs folder run
Now you able to build documentation locally.
When making minor edits, it is usually safe to simply render the edited from Markdown to HTML. Many code editors have plugins to render Markdown to HTML and there are a handful of good online editors.
Currently, a Node.JS script and joDoc-js are used to generate the HTML documentation.
There is a Rake task to increment the version, generate the version directory, and update the edge documentation.
# generate version 4.1.0 for english. .\bin\incrementversion en 4.1.0