{"id":28440276,"url":"https://github.com/haxefoundation/code-cookbook","last_synced_at":"2025-06-27T10:32:40.524Z","repository":{"id":6018304,"uuid":"54491629","full_name":"HaxeFoundation/code-cookbook","owner":"HaxeFoundation","description":"The Haxe Code Cookbook - A community driven resource website for learning Haxe in practise","archived":false,"fork":false,"pushed_at":"2025-05-12T06:48:58.000Z","size":3178,"stargazers_count":115,"open_issues_count":6,"forks_count":88,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-06-06T03:41:52.900Z","etag":null,"topics":["cookbook","documentation","haxe","website"],"latest_commit_sha":null,"homepage":"https://code.haxe.org","language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaxeFoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"haxe","custom":["https://haxe.org/foundation/support-plans.html","https://haxe.org/foundation/donate.html"]}},"created_at":"2016-03-22T16:37:28.000Z","updated_at":"2025-05-22T13:02:17.000Z","dependencies_parsed_at":"2024-02-01T22:45:14.845Z","dependency_job_id":"cdbb232a-2c6b-47dc-bb41-d4d4de5da093","html_url":"https://github.com/HaxeFoundation/code-cookbook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/HaxeFoundation/code-cookbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fcode-cookbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fcode-cookbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fcode-cookbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fcode-cookbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaxeFoundation","download_url":"https://codeload.github.com/HaxeFoundation/code-cookbook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fcode-cookbook/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262239193,"owners_count":23280280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookbook","documentation","haxe","website"],"created_at":"2025-06-06T03:39:22.615Z","updated_at":"2025-06-27T10:32:40.513Z","avatar_url":"https://github.com/HaxeFoundation.png","language":"Haxe","funding_links":["https://opencollective.com/haxe","https://haxe.org/foundation/support-plans.html","https://haxe.org/foundation/donate.html"],"categories":[],"sub_categories":[],"readme":"# Haxe Code Cookbook\n\n[![Build Status](https://travis-ci.org/HaxeFoundation/code-cookbook.svg?branch=master)](https://travis-ci.org/HaxeFoundation/code-cookbook)\n\n\u003e Sources for the [Haxe Code Cookbook](http://code.haxe.org) site, a community driven resource website for learning Haxe in practise.\n\nThe repository contains a static website generator, which converts markdown articles into a website. The project is being developed here on GitHub, feel free to contribute Haxe related code snippets and tutorials.\n\n## Structure\n\n * The actual articles are in [assets/content/cookbook](assets/content/cookbook), organized per folder.\n * The html template files are in [assets/content/](assets/content).\n * The static files (css, js, images) files are in [assets/includes/](assets/includes).\n * The Haxe source files of the generator are in [src/](src).\n * The website-generated content will output in `output/` (excluded from git).\n\n## Contributing \n\n## Contributing changes\n\nTo contribute a change, you have to make a pull request. This can be done using the GitHub website or by fork/cloning the project.\n\n##### Contributing using GitHub as online editor \n\nThis is the easiest way of doing small changes:\n\n- Navigate to an article on \u003chttps://code.haxe.org\u003e and press the edit button on any page: ![image](https://user-images.githubusercontent.com/576184/78226927-c544eb00-74cc-11ea-8d59-8658b017126f.png)\n- You are redirected to GitHub. Once you have an account and are logged in, you can make the change in the online editor.\n- Set the description / what you changed and press the _Request change_ button:\n![image](https://user-images.githubusercontent.com/576184/78226584-3506a600-74cc-11ea-878f-4070ca04107d.png)\n- A pull request will be created. GitHub makes a fork for you automatically.\n\n##### Contributing using a fork\n\nThis would also allow to test/see the changes before submitting which is also useful when you want to add new pages.\n\n- Make a fork (on GitHub) of the project.\n- Checkout your repo on your machine, create a new branch for the pull request.\n- Make the changes in that new branch.\n- Push the commits (they go to your fork).\n- On GitHub, you make a pull request from your fork's branch to the original repo.\n\n## Creating articles\n\nPlease add/edit the articles (markdown files) in the [assets folder](assets/content/cookbook) and do a pull request. The scope of the cookbook includes the core language, the standard library, and also any libraries maintained by the Haxe Foundation.\n\n#### Formatting \n\nIt would be nice if you keep the formatting of the code in the same style as used already:\n\n * Braces on same line.\n * Two-space indentation.\n * No type-hints for local variables and function return unless it's instructive.\n * Type-hints for fields.\n * Type-hints for function arguments unless it's very obvious.\n * Judicious use of extra line-breaks to avoid ugly automatic breaks (check the output).\n \n#### Other remarks\n \n * The first heading is used in the navigation. Keep this title short.\n * The first paragraph is used as description. Describe what the content of the article is about.\n * Use `\u003e Author: [Name](https://github.com/username)` to mark yourself as author of the article. The other contributors are inferred from git commits.\n * Tag the article using `[tags]: / \"tag1,tag2\"` (no spaces). Try to use [an existing tag](http://code.haxe.org/).\n * Mention the author / sources at the bottom of the page.\n * If you want to include a [try.haxe.org](https://try.haxe.org) code snippet use `[tryhaxe](https://try.haxe.org/embed/76f24)`.\n * If you want to include a YouTube video use `[youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ)`.\n * If possible, link to related pages in the [Haxe Manual](https://haxe.org/manual) / [API documentation](https://api.haxe.org).\n * If you want to use images or other includes, create a folder called _assets_ in the same directory as the article and link to that.\n\nThis would be a typical template to use. Use \u003ccode\u003e```haxe\u003c/code\u003e for syntax highlighting:\n \n\u003cpre\u003e\n\u0026lbrack;tags\u0026rbrack;: / \"class,array,json,building-fields\"\n\n# Title of the page\n\nDescription and explanation of the code.\n\n## Implementation\n\u0026grave;\u0026grave;\u0026grave;haxe\nclass Main {\n  // Code here\n}\n\u0026grave;\u0026grave;\u0026grave;\n\n## Usage\n\nDescription of how to use/test the code.\n\n\u0026grave;\u0026grave;\u0026grave;haxe\nclass Test {\n  // Code here\n}\n\u0026grave;\u0026grave;\u0026grave;\n\n\u0026gt; More on this topic: \n\u0026gt; \n\u0026gt; * \u0026lbrack;Class field in Haxe Manual\u0026rbrack;(https://haxe.org/manual/class-field.html)\n\u0026gt; \n\u0026gt; Author: \u0026lbrack;Name\u0026rbrack;(https://github.com/username)\n\u003c/pre\u003e\n\n## Running a local copy\n\nTo run the project you can use Neko:\n\nCall `neko CodeCookBook.n` to re-generate the output files.\n\n## Contributing to the generator\n\nYou need [Haxe 3.4.2+](https://haxe.org/download/list/) installed.\n\nThe static site generator source depends on [hxtemplo](https://lib.haxe.org/p/hxtemplo) and [haxe-markdown](https://lib.haxe.org/p/markdown).\n\nInstall the libraries using haxelib, run the following command in the root of the project:\n```\nhaxelib install all\n```\nThe CSS files are compressed using [less](http://lesscss.org/#using-less). \nInstall from npm:\n```\nnpm install -g less\nnpm install -g less-plugin-clean-css\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxefoundation%2Fcode-cookbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaxefoundation%2Fcode-cookbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxefoundation%2Fcode-cookbook/lists"}