code cookbook

HAXE代碼食譜

HAXE代碼食譜網站的資源，這是一個社區驅動的資源網站，用於學習HAXE。

存儲庫包含一個靜態網站生成器，該網站發電機將Markdown文章轉換為網站。該項目正在Github上開發，隨時可以為HAXE相關的代碼片段和教程提供。

結構

• 實際文章中有資產/內容/食譜，每個文件夾組織。
• HTML模板文件在資產/內容/中。
• 靜態文件（CSS，JS，圖像）文件在資產/INCLUCE/中。
• 生成器的HAXE源文件在SRC/中。
• 網站生成的內容將輸出output/ （從GIT中排除）。

貢獻

貢獻變化

為了做出更改，您必須提出拉動請求。這可以使用GitHub網站或叉子/克隆項目來完成。

使用GitHub作為在線編輯器貢獻

這是進行小型更改的最簡單方法：

• 導航到https://code.haxe.org上的文章，然後按任何頁面上的編輯按鈕：
• 您被重定向到github。有一個帳戶並登錄後，您可以在線編輯中進行更改。
• 設置說明 /您更改的內容，然後按請求更改按鈕：
• 將創建拉動請求。 Github會自動為您製作叉子。

使用叉子貢獻

這也將允許在提交之前測試/查看更改，這在您想添加新頁面時也很有用。

• 製作項目的叉子（在github上）。
• 在計算機上查看存儲庫，為拉請求創建一個新的分支。
• 對該新分支進行更改。
• 推動提交（他們去您的叉子）。
• 在github上，您從叉子的分支到原始存儲庫提出了拉動請求。

創建文章

請在資產文件夾中添加/編輯文章（Markdown Files），並執行拉動請求。食譜的範圍包括核心語言，標準庫以及Haxe基金會維護的任何庫。

格式化

如果您將代碼格式保持與已經使用的樣式相同的樣式，那將是很好的：

• 在同一條線上的牙套。
• 兩個空間凹痕。
• 除非具有啟發性，否則沒有針對本地變量的類型暗示和函數返回。
• 字段的類型刺激。
• 函數參數的類型圖是非常明顯的。
• 明智地使用額外的線路斷路，以避免醜陋的自動斷裂（檢查輸出）。

其他言論

• 第一個標題用於導航。簡短這個標題。
• 第一段用作描述。描述文章的內容。
• 使用> 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文檔中的相關頁面。
• 如果要使用圖像或其他包含的圖像，請在與文章相同的目錄中創建一個名為Assets的文件夾，然後鏈接到該文件夾​​。

這將是一個典型的使用模板。使用```haxe for語法亮點：

 [標籤]： /“類，數組，JSON，建築物”

＃頁面標題

代碼的描述和說明。

＃＃ 執行
````haxe
類Main {
  //在這裡代碼
}
````````

＃＃ 用法

描述如何使用/測試代碼。

````haxe
類測試{
  //在這裡代碼
}
````````

>有關此主題的更多信息： 
> 
> * [HAXE手冊中的類字段]（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