https://github.com/apache/cordova-docs

Apache Cordova Documentation
https://github.com/apache/cordova-docs

blog cordova docs documentation hacktoberfest javascript mobile nodejs website

Last synced: about 8 hours ago
JSON representation

Apache Cordova Documentation

• Host: GitHub
• URL: https://github.com/apache/cordova-docs
• Owner: apache
• License: apache-2.0
• Created: 2012-11-28T08:00:26.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2025-02-14T01:15:00.000Z (8 days ago)
• Last Synced: 2025-02-14T07:49:14.122Z (7 days ago)
• Topics: blog, cordova, docs, documentation, hacktoberfest, javascript, mobile, nodejs, website
• Language: JavaScript
• Homepage: https://cordova.apache.org/
• Size: 246 MB
• Stars: 352
• Watchers: 49
• Forks: 557
• Open Issues: 58
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/apache/cordova-docs.svg?branch=master)](https://travis-ci.org/apache/cordova-docs)

# Cordova Docs / Website

This repository contains the source code for the Cordova website at [cordova.apache.org](https://cordova.apache.org).

## Technical Overview

The main parts are built as a static site with [Jekyll](http://jekyllrb.com/), containing the homepage and subpages, the [blog](https://cordova.apache.org/blog) and the [docs](https://cordova.apache.org/docs).

Here in the repository the code of the actual site is located in [`/www`](www) with its subfolder [`/docs`](www/docs), [`/blog`](www/blog) and [`/plugins`](www/plugins).  

Some additional content is [pulled in during the build process](TODO).

The site is built using a [gulp script](gulpfile.js) 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`](buildAndDeploy.sh) and commits the built site to a SVN repository.

## Instructions

- [Installing](doc/installing-a-development-environment.md)

- [Developing](doc/developing-the-website.md)

  * [Docs Redirects](doc/redirects.md)

- [Testing](doc/testing-the-website.md)

- Manual [Build](doc/building-the-website.md) and [Deployment](doc/deploying-the-website.md)

- [Automated Build and Deployment](doc/building-and-deploying-the-website.md) on commits/merges to `master` via Travis

- [Troubleshooting](doc/troubleshooting.md)

### Common Tasks

- [Working on `www/docs`](doc/working-on-docs.md) (updating from `dev`, creating new version, pulling in external docs)

- [Writing a Blog Post](doc/blogpost.md)

- [Adding a Tool or a Showcase App](doc/tool-or-showcase-app.md)

- [Translating](doc/translate.md)

## Attributions

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