Dokumentation zum Apache Cordova API

Die JavaScript-API-Dokumentation für Apache-Cordova.

Die Dokumentation ist unter docs.cordova.io verfügbar.

Dokumentationsformat

Alle Apache-Cordova -Dokumentation geschrieben mit Markdown, eine leichte Markup-Sprache, die in HTML geschrieben werden kann. Markdown bietet eine einfache und flexible Möglichkeit, Cordova Core API und plattformspezifischen APIs zu dokumentieren.

Dateistruktur

docs/
docs/LANGUAGE
docs/LANGUAGE/VERSION
docs/LANGUAGE/VERSION/cordova/
docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/

Zu der Dokumentation beitragen

Melden oder ein Problem zu beheben

Wir verwenden Apache JIRA

Übrigens, wiegen Sie! Vielen Dank, dass uns die Dokumentation zu verbessern!

Mit Hilfe von Git

Sind Sie neu bei Git oder auf GitHub beiträgt?

Wir haben ein paar Git-Tutorials geschrieben , helfen Ihnen den Einstieg mit zu der Dokumentation beitragen.

Senden von Pull-Anforderungen

Pull-Requests sind willkommen!

Wir bedanken uns für die Nutzung der Thema-Filialen.

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

Hinzufügen einer Sprache

Wollen Sie die Apache-Cordova-Dokumentation in einer anderen Sprache? Wir tun es auch! Mit der Unterstützung der Crowdineine Übersetzung und Lokalisierung-Management-Plattform können Übersetzer einloggen, um die einfach zu bedienende Werkzeuge und bieten so viel oder so wenig Übersetzung Unterstützung, wie sie möchten. Wenn Sie, eine andere Sprache bitte Cordova zu unterstützen und einen Beitrag leisten wissen. http://crowdin.net/project/cordova. Einige bewährte Methoden zur Nutzung des Crowdin-Tools finden Sie in unserer Wiki-http://wiki.apache.org/cordova/CordovaTranslations.

Cordova Sprache Administratoren, vergessen Sie nicht folgende Schritte aus:

1. config.json

Für jede Sprache und Version gibt es eine config.json , die den Namen der Sprache und Zusammenführen von Dateien definiert.

2. Anpassen der HTML-Vorlage

Jede Sprache kann die Standard-Vorlage in Vorlage/Docs/Sprache überschreiben..

Redaktionelle Richtlinien

Finden Sie auf Sprache und Verwendung in der Datei STYLESHEET.md Richtlinien.

Generierung von Dokumentation mit Node.js

Jetzt konnte die Dokumentation mit Node.js entweder auf Windows oder Linux-Rechner ausgeführt werden.

$ 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

Einrichten von Node.js

1. Gehen Sie auf Node.JS -Downloadseite

2. Downloaden Sie und installieren Sie Paket für Ihr Betriebssystem.

3. Kasse dieses mit Git Repository

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

4. Abhängigkeiten zu installieren. In der Wurzel der geklonten Cordova-Docs-Ordner ausführen

   npm install

5. Jetzt können Sie in der Lage, zur Erstellung von Dokumentation lokal.

Schnelle Vorschau

Wenn Sie kleinere Bearbeitungen vornehmen, ist es normalerweise sicher einfach die bearbeitete von Markdown in HTML gerendert. Viele Code-Editoren haben Plugins Markdown für HTML zu rendern, und es gibt eine Handvoll guter online-Redaktion.

Derzeit sind ein Node.JS Skript und JoDoc-Js zum Generieren von HTML-Dokumentation.

Erzeugen einer Version Release

Es gibt eine Rake-Aufgabe und die Version, das Versionsverzeichnis zu generieren und aktualisieren die Rand-Dokumentation.

# generate version 4.1.0 for english.
.\bin\incrementversion en 4.1.0