code cookbook

Haxe Code Cookbook

HAXE Code Cookbookサイトのソース、実際にHAXEを学習するためのコミュニティ主導のリソースWebサイト。

リポジトリには、マークダウンの記事をWebサイトに変換する静的なWebサイトジェネレーターが含まれています。このプロジェクトはGitHubでここで開発されています。ハクセ関連のコードスニペットとチュートリアルをお気軽に提供してください。

構造

• 実際の記事は、フォルダーごとに整理された資産/コンテンツ/クックブックにあります。
• HTMLテンプレートファイルはAssets/Content/にあります。
• 静的ファイル（CSS、JS、画像）ファイルはAssets/include/にあります。
• ジェネレーターのHAXEソースファイルはSRC/にあります。
• Webサイトで生成されたコンテンツはoutput/ （GITから除外）で出力されます。

貢献

変更の貢献

変更に貢献するには、プルリクエストを行う必要があります。これは、Github Webサイトを使用して、またはプロジェクトのフォーク/クローニングで実行できます。

Githubをオンラインエディターとして使用して貢献します

これは、小さな変更を行う最も簡単な方法です。

• https://code.haxe.orgの記事に移動し、任意のページの編集ボタンを押します。
• Githubにリダイレクトされます。アカウントを取得してログインしたら、オンラインエディターに変更を加えることができます。
• 説明 /変更したものを設定して、リクエストの変更ボタンを押します。
• プルリクエストが作成されます。 Githubは自動的にフォークを作成します。

フォークを使用して貢献します

これにより、新しいページを追加する場合にも役立つ変更を送信する前に、変更をテスト/表示できます。

• プロジェクトのフォーク（github）を作成します。
• マシンのリポジトリをチェックアウトし、プルリクエスト用の新しいブランチを作成します。
• その新しいブランチに変更を加えます。
• コミットを押してください（彼らはあなたのフォークに行きます）。
• Githubでは、フォークのブランチから元のリポジトリまでプルリクエストを行います。

記事の作成

Assetsフォルダーに記事（Markdownファイル）を追加/編集して、プルリクエストを実行してください。 Cookbookの範囲には、コア言語、標準ライブラリ、およびHaxe Foundationが維持しているライブラリが含まれます。

フォーマット

すでに使用されているのと同じスタイルでコードのフォーマットを保持すると、それは素晴らしいことです。

• 同じラインのブレース。
• 2つのスペースインデント。
• 有益でない限り、ローカル変数や関数のリターンのタイプヒントはありません。
• フィールドのタイプヒント。
• それが非常に明白でない限り、関数引数のタイプヒント。
• 醜い自動休憩を避けるために、追加のラインブレークを賢明な使用します（出力を確認してください）。

その他の発言

• 最初の見出しはナビゲーションで使用されます。このタイトルを短くしてください。
• 最初の段落は説明として使用されます。記事の内容が何であるかを説明してください。
• 使用> Author: [Name](https://github.com/username)記事の著者としてマークします。他の貢献者は、GITコミットから推測されます。
• [tags]: / "tag1,tag2" （スペースなし）を使用して記事にタグを付けます。既存のタグを使用してみてください。
• ページの下部にある著者 /ソースに言及してください。
• try.haxe.orgコードスニペットを含める場合は[tryhaxe](https://try.haxe.org/embed/76f24)を使用します。
• YouTubeビデオを含める場合は[youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ)を使用します。
• 可能であれば、HAXEマニュアル / APIドキュメントの関連ページにリンクします。
• 画像またはその他を使用する場合は、記事と同じディレクトリにあるアセットと呼ばれるフォルダーを作成し、それにリンクします。

これは、使用する典型的なテンプレートです。構文の強調表示には```haxeを使用します。

 [タグ]： /「クラス、配列、JSON、ビルディングフィールド」

＃ページのタイトル

コードの説明と説明。

＃＃ 実装
`` haxe
クラスメイン{
  //ここにコードします
}
`` `

＃＃ 使用法

コードの使用方法/テスト方法の説明。

`` haxe
クラステスト{
  //ここにコードします
}
`` `

>このトピックの詳細： 
> 
> * [Haxe Manualのクラスフィールド]（https://haxe.org/manual/class-field.html）
> 
>著者：[name]（https://github.com/username）

ローカルコピーを実行します

プロジェクトを実行するには、Nekoを使用できます。

neko CodeCookBook.nに電話して、出力ファイルを再生成します。

発電機に貢献します

HAXE 3.4.2+がインストールされる必要があります。

静的サイトジェネレーターのソースは、hxtemploとhaxe-markdownに依存します。

Haxelibを使用してライブラリをインストールし、プロジェクトのルートで次のコマンドを実行します。

 haxelib install all

CSSファイルは、より少ないものを使用して圧縮されます。 NPMからのインストール：

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