code cookbook

Livre de cuisine de code haxe

Sources du site de livres de cuisine du code HAxe, un site Web de ressources axé sur la communauté pour apprendre Haxe dans la pratique.

Le référentiel contient un générateur de sites Web statique, qui convertit les articles de Markdown en un site Web. Le projet est développé ici sur GitHub, n'hésitez pas à apporter des extraits de code et des tutoriels liés à Haxe.

Structure

• Les articles réels sont en actifs / contenu / livre de cuisine, organisés par dossier.
• Les fichiers de modèle HTML sont dans Assets / Content /.
• Les fichiers statiques (CSS, JS, Images) sont en actifs / incluse /.
• Les fichiers source HAXE du générateur sont dans SRC /.
• Le contenu généré par le site Web sortira en output/ (exclu de GIT).

Contributif

Modifications contributives

Pour contribuer un changement, vous devez faire une demande de traction. Cela peut être fait en utilisant le site Web GitHub ou par fourche / clonage du projet.

Contribution utilisant GitHub comme éditeur en ligne

C'est le moyen le plus simple de faire de petits changements:

• Accédez à un article sur https://code.haxe.org et appuyez sur le bouton Modifier sur n'importe quelle page:
• Vous êtes redirigé vers GitHub. Une fois que vous avez un compte et que vous êtes connecté, vous pouvez effectuer le changement dans l'éditeur en ligne.
• Définissez la description / ce que vous avez changé et appuyez sur le bouton de modification de la demande :
• Une demande de traction sera créée. GitHub vous fait une fourchette automatiquement.

Contribuant à l'utilisation d'une fourchette

Cela permettrait également de tester / voir les modifications avant de soumettre, ce qui est également utile lorsque vous souhaitez ajouter de nouvelles pages.

• Faites une fourche (sur GitHub) du projet.
• Découvrez votre dépôt sur votre machine, créez une nouvelle branche pour la demande de traction.
• Apporter les changements dans cette nouvelle branche.
• Poussez les commits (ils vont à votre fourchette).
• Sur GitHub, vous faites une demande de traction de la branche de votre fourche vers le dépôt d'origine.

Création d'articles

Veuillez ajouter / modifier les articles (fichiers Markdown) dans le dossier Assets et faire une demande de traction. La portée du livre de cuisine comprend la langue principale, la bibliothèque standard et également toutes les bibliothèques entretenues par la HAxe Foundation.

Formatage

Ce serait bien si vous conservez le formatage du code dans le même style que celui utilisé:

• Accolades sur la même ligne.
• Indentation à deux espaces.
• Pas de types de type pour les variables locales et la fonction ne revient à moins qu'elle ne soit instructive.
• Type-In-ints pour les champs.
• Type-Hints for Function Arguments Sauf si c'est très évident.
• Utilisation judicieuse des brise-ligne supplémentaires pour éviter les pauses automatiques laides (vérifiez la sortie).

Autres remarques

• Le premier titre est utilisé dans la navigation. Gardez ce titre court.
• Le premier paragraphe est utilisé comme description. Décrivez le contenu de l'article.
• Utilisez > Author: [Name](https://github.com/username) pour vous marquer comme auteur de l'article. Les autres contributeurs sont déduits de Git Commits.
• Tags l'article à l'aide de [tags]: / "tag1,tag2" (pas d'espaces). Essayez d'utiliser une balise existante.
• Mentionnez l'auteur / les sources en bas de la page.
• Si vous souhaitez inclure un extrait de code Try.haxe.org Utilisez [tryhaxe](https://try.haxe.org/embed/76f24) .
• Si vous souhaitez inclure une vidéo YouTube, utilisez [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Si possible, lien vers des pages connexes dans la documentation manuelle / API HAXE.
• Si vous souhaitez utiliser des images ou d'autres incluses, créez un dossier appelé Assets dans le même répertoire que l'article et liez à cela.

Ce serait un modèle typique à utiliser. Utilisez ```haxe pour la mise en évidence de la syntaxe:

 [Tags]: / "Classe, Array, JSON, Building Fields"

# Titre de la page

Description et explication du code.

## Mise en œuvre
`` Haxe
classe Main {
  // code ici
}
`` '

## Utilisation

Description de la façon d'utiliser / tester le code.

`` Haxe
classe Test {
  // code ici
}
`` '

> Plus sur ce sujet: 
> 
> * [Champ de classe dans Haxe Manual] (https://haxe.org/manual/class-field.html)
> 
> Auteur: [nom] (https://github.com/username)

Exécuter une copie locale

Pour exécuter le projet, vous pouvez utiliser Neko:

Appelez neko CodeCookBook.n pour générer les fichiers de sortie.

Contribuant au générateur

Vous avez besoin de HAXE 3.4.2+ installé.

La source de générateur de sites statique dépend de HXTemplo et de la markdown haxe.

Installez les bibliothèques à l'aide de Hoxelib, exécutez la commande suivante à la racine du projet:

 haxelib install all

Les fichiers CSS sont compressés à l'aide de moins. Installer à partir de NPM:

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