code cookbook

HAXE -Code -Kochbuch

Quellen für die HAXE -Code -Kochbuch -Site, eine Community -Ressourcen -Website zum Erlernen von Haxe in der Praxis.

Das Repository enthält einen statischen Website -Generator, der Markdown -Artikel in eine Website umwandelt. Das Projekt wird hier auf Github entwickelt. Sie können sich gerne mit Haxe -bezogenen Code -Snippets und Tutorials beibehalten.

Struktur

• Die tatsächlichen Artikel befinden sich in Vermögenswerten/Inhalten/Kochbuch, organisiert pro Ordner.
• Die HTML -Vorlagendateien befinden sich in Assets/Inhalten/.
• Die statischen Dateien (CSS, JS, Images) -Dateien befinden sich in Vermögenswerten/include/.
• Die Haxe -Quelldateien des Generators befinden sich in SRC/.
• Der von der Website erstellte Inhalt wird in output/ (ausgeschlossen von Git) ausgegeben.

Beitragen

Veränderungen beitragen

Um eine Änderung beizutragen, müssen Sie eine Pull -Anfrage stellen. Dies kann über die GitHub -Website oder nach Gabel/Klonen des Projekts erfolgen.

Mit GitHub als Online -Editor beitragen

Dies ist die einfachste Art, kleine Veränderungen vorzunehmen:

• Navigieren Sie zu einem Artikel auf https://code.haxe.org und drücken Sie die Schaltfläche Bearbeiten auf einer beliebigen Seite:
• Sie werden zu Github umgeleitet. Sobald Sie ein Konto haben und angemeldet sind, können Sie die Änderung im Online -Editor vornehmen.
• Setzen Sie die Beschreibung / was Sie geändert haben, und drücken Sie die Schaltfläche "Anforderungsänderung" :
• Eine Pull -Anfrage wird erstellt. GitHub macht automatisch eine Gabel für Sie.

Mithilfe einer Gabel beitragen

Dies würde auch ermöglichen, die Änderungen vor dem Einreichen zu testen/zu sehen, was auch nützlich ist, wenn Sie neue Seiten hinzufügen möchten.

• Machen Sie eine Gabel (auf Github) des Projekts.
• Schauen Sie sich Ihr Repo auf Ihrem Computer an und erstellen Sie eine neue Filiale für die Pull -Anfrage.
• Nehmen Sie die Änderungen in diesem neuen Zweig vor.
• Schieben Sie die Commits (sie gehen zu Ihrer Gabel).
• Auf GitHub stellen Sie eine Pull -Anfrage von der Zweigstelle Ihrer Gabel zum ursprünglichen Repo.

Artikel erstellen

Bitte fügen Sie die Artikel (Markdown -Dateien) in den Ordner assets hinzu/bearbeiten Sie eine Pull -Anfrage. Der Umfang des Kochbuchs umfasst die Kernsprache, die Standardbibliothek und auch alle Bibliotheken, die von der Haxe Foundation geführt werden.

Formatierung

Es wäre schön, wenn Sie die Formatierung des Codes im gleichen Stil wie bereits verwendet haben:

• Zahnspangen auf derselben Linie.
• Zwei-Raum-Eindrückung.
• Keine Typ-Hinweise für lokale Variablen und Funktionsrendite, es sei denn, es ist lehrreich.
• Typ-Hinweise für Felder.
• Typ-Hinweise für Funktionsargumente, es sei denn, es ist sehr offensichtlich.
• Nehmen Sie sich zusätzliche Zeilenumbrüche aus, um hässliche automatische Pausen zu vermeiden (die Ausgabe überprüfen).

Andere Bemerkungen

• Die erste Überschrift wird in der Navigation verwendet. Halten Sie diesen Titel kurz.
• Der erste Absatz wird als Beschreibung verwendet. Beschreiben Sie, worum es in dem Inhalt des Artikels geht.
• Verwenden Sie > Author: [Name](https://github.com/username) um sich als Autor des Artikels zu markieren. Die anderen Mitwirkenden werden aus Git Commits abgeleitet.
• Tags mit dem Artikel mit [tags]: / "tag1,tag2" (keine Leerzeichen). Versuchen Sie, ein vorhandenes Tag zu verwenden.
• Erwähnen Sie den Autor / die Quellen am Ende der Seite.
• Wenn Sie einen Code -Snippet -Snippet [tryhaxe](https://try.haxe.org/embed/76f24) einfügen möchten.
• Wenn Sie ein YouTube -Video einfügen möchten, verwenden Sie [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Wenn möglich, verlinken Sie zu den zugehörigen Seiten in der HAXE -Handbuch / API -Dokumentation.
• Wenn Sie Bilder verwenden möchten, die Bilder verwenden möchten, erstellen Sie einen Ordner namens Assets im selben Verzeichnis wie der Artikel und verlinken dazu.

Dies wäre eine typische Vorlage. Verwenden Sie ```haxe für die Syntax -Hervorhebung:

 [Tags]: / "Klasse, Array, JSON, Gebäudefelder"

# Titel der Seite

Beschreibung und Erläuterung des Code.

## Implementierung
`` `haxe
Klasse Haupt {
  // Code hier
}
`` `

## Verwendung

Beschreibung der Verwendung/Prüfung des Codes.

`` `haxe
Klassentest {
  // Code hier
}
`` `

> Mehr zu diesem Thema: 
> 
> * [Klassenfeld im Haxe-Handbuch] (https://haxe.org/manual/class-field.html)
> 
> Autor: [Name] (https://github.com/username)

Ausführen einer lokalen Kopie

Um das Projekt auszuführen, können Sie Neko verwenden:

Rufen Sie neko CodeCookBook.n an, um die Ausgabedateien neu zu generieren.

Beitrag zum Generator

Sie benötigen Haxe 3.4.2+ installiert.

Die Quelle für statische Site Generator hängt von Hxtemplo und Haxe-Markdown ab.

Installieren Sie die Bibliotheken mit Haxelib und führen Sie den folgenden Befehl im Root des Projekts aus:

 haxelib install all

Die CSS -Dateien werden mit weniger komprimiert. Installieren Sie von NPM:

 npm install -g less
npm install -g less-plugin-clean-css