{"id":13471093,"url":"https://github.com/HaxeFlixel/flixel-docs","last_synced_at":"2025-03-26T13:30:50.096Z","repository":{"id":12843910,"uuid":"15519547","full_name":"HaxeFlixel/flixel-docs","owner":"HaxeFlixel","description":"Documentation for HaxeFlixel","archived":false,"fork":false,"pushed_at":"2025-03-07T18:46:18.000Z","size":54510,"stargazers_count":76,"open_issues_count":19,"forks_count":133,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-20T19:29:43.484Z","etag":null,"topics":["api","api-documentation","documentation","dox","haxeflixel"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/HaxeFlixel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2013-12-30T03:17:53.000Z","updated_at":"2025-03-11T19:37:23.000Z","dependencies_parsed_at":"2024-08-28T18:01:05.745Z","dependency_job_id":"ab341c95-fd53-4812-acbd-b045d444ac2a","html_url":"https://github.com/HaxeFlixel/flixel-docs","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFlixel%2Fflixel-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFlixel%2Fflixel-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFlixel%2Fflixel-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFlixel%2Fflixel-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaxeFlixel","download_url":"https://codeload.github.com/HaxeFlixel/flixel-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245662740,"owners_count":20652073,"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":["api","api-documentation","documentation","dox","haxeflixel"],"created_at":"2024-07-31T16:00:39.668Z","updated_at":"2025-03-26T13:30:50.090Z","avatar_url":"https://github.com/HaxeFlixel.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"![](https://github.com/HaxeFlixel/haxeflixel.com/blob/dev/content/_static/images/flixel-logos/flixel-docs.png?raw=true)\n\n[flixel](https://github.com/HaxeFlixel/flixel) | [addons](https://github.com/HaxeFlixel/flixel-addons) | [ui](https://github.com/HaxeFlixel/flixel-ui) | [demos](https://github.com/HaxeFlixel/flixel-demos) | [tools](https://github.com/HaxeFlixel/flixel-tools) | [templates](https://github.com/HaxeFlixel/flixel-templates) | [docs](https://github.com/HaxeFlixel/flixel-docs) | [haxeflixel.com](https://github.com/HaxeFlixel/haxeflixel.com)\n\n[![CI](https://img.shields.io/github/actions/workflow/status/HaxeFlixel/flixel-docs/main.yml?branch=master\u0026logo=github)](https://github.com/HaxeFlixel/flixel-docs/actions?query=workflow%3ACI)\n\n## About\n\nThis is the main location for HaxeFlixel documentation. Pull requests from this location will be pushed to the live website periodically, so please help us improve the HaxeFlixel docs.\n\n## Contents\n\n* The \"main\" documentation available on [haxeflixel.com/documentation](https://haxeflixel.com/documentation).\n* The API documentation.\n\n### Main documentation\n\nThe main documentation is made up of `*.html.md` files in the `./documentation` folder. Each file and folder starts with a numerical prefix specifying the order listed on the [docpad website](https://github.com/HaxeFlixel/haxeflixel.com).\n\nAdditional pages can be added using the same extension and using a header specifying the title as seen in the other pages. Eg:\n```\n\t---\n\ttitle: \"Documentation Page\"\n\t---\n```\t\n\tUse Regular GitHub flavoured markdown for the page.\n\tNote `title:` above is case sensitive.\n\nThe markdown syntax used in the docs is the  [GitHub-Flavored-Markdown](https://help.github.com/articles/github-flavored-markdown), thus it's very convenient to directly edit the files via GitHub's web editor. \n\n### API documentation\n\t\nAPI documentation is provided in the `./api` folder, they are currently generated with [dox](https://github.com/HaxeFoundation/dox). You can view the API docs offline by cloning this directory, checking out the `gh-pages` branch, running `nekotools server` in `./api` and navigating to [localhost:2000](http://localhost:2000/).\n\nTo generate the API docs yourself, you need to first run `npm install` in `api/dox`. Then run the following from the root directory:\n\n```\nhaxe --cwd api --run Make xml pages server\n```\n\nThe docs will now be generated in the `api/dox/out` folder and a local webserver started at `localhost:2000`.\n\nNote this will use your locally enabled haxelib flixel versions, e.g. if you have `haxelib git flixel` set to `dev` etc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeFlixel%2Fflixel-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHaxeFlixel%2Fflixel-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeFlixel%2Fflixel-docs/lists"}