README.md

Cordova Docs / Website

This repository contains the source code for the Cordova website at cordova.apache.org.

Technical Overview

The main parts are built as a static site with Jekyll, containing the homepage and subpages, the blog and the docs.

Here in the repository the code of the actual site is located in /www with its subfolder /docs, /blog and /plugins.
Some additional content is pulled in during the build process.

The site is built using a gulp script that is run by Node.JS (npm run-script build). (Alternatively you can build the site using Make.) Deployments usually happen on commits to master via Travis, which runs buildAndDeploy.sh and commits the built site to a SVN repository.

Instructions

• Installing
• Developing
  • Docs Redirects
• Testing
• Manual Build and Deployment
• Automated Build and Deployment on commits/merges to master via Travis
• Troubleshooting

Common Tasks

• Working on www/docs (updating from dev, creating new version, pulling in external docs)
• Writing a Blog Post
• Adding a Tool or a Showcase App
• Translating

Attributions

For attributions for used open-source work, please see the attributions page: www/attributions.html.