{"id":28440301,"url":"https://github.com/haxefoundation/dox","last_synced_at":"2026-01-31T15:31:55.975Z","repository":{"id":41070624,"uuid":"10242926","full_name":"HaxeFoundation/dox","owner":"HaxeFoundation","description":"Haxe documentation generator.","archived":false,"fork":false,"pushed_at":"2024-09-26T20:26:53.000Z","size":5689,"stargazers_count":149,"open_issues_count":33,"forks_count":37,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-06-06T03:41:53.122Z","etag":null,"topics":["documentation-generator","documentation-tool","haxe"],"latest_commit_sha":null,"homepage":null,"language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HaxeFoundation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2013-05-23T12:10:00.000Z","updated_at":"2025-05-13T19:03:47.000Z","dependencies_parsed_at":"2023-12-28T00:02:46.635Z","dependency_job_id":"37b77ec5-4a17-4e98-a7ca-5c9184783796","html_url":"https://github.com/HaxeFoundation/dox","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/HaxeFoundation/dox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaxeFoundation","download_url":"https://codeload.github.com/HaxeFoundation/dox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeFoundation%2Fdox/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262238647,"owners_count":23280174,"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":["documentation-generator","documentation-tool","haxe"],"created_at":"2025-06-06T03:39:25.797Z","updated_at":"2026-01-31T15:31:55.925Z","avatar_url":"https://github.com/HaxeFoundation.png","language":"Haxe","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dox\n[![Build Status](https://github.com/HaxeFoundation/dox/workflows/CI/badge.svg \"GitHub Actions\")](https://github.com/HaxeFoundation/dox/actions?query=workflow%3ACI)\n[![Haxelib Version](https://badgen.net/haxelib/v/dox)](https://lib.haxe.org/p/dox)\n[![Haxelib Downloads](https://badgen.net/haxelib/d/dox?color=blue)](https://lib.haxe.org/p/dox)\n[![Haxelib License](https://badgen.net/haxelib/license/dox)](LICENSE.md)\n\n\nA Haxe documentation generator used by many popular projects such as:\n\n- [Haxe](https://api.haxe.org/)\n- [OpenFL](https://api.openfl.org/)\n- [HaxeFlixel](https://api.haxeflixel.com/)\n- [Heaps](https://heaps.io/api/)\n- [Kha](http://api.kha.tech/)\n- [Ceramic](https://ceramic-engine.com/api-docs/)\n\n![image](resources/screenshot.png)\n\n\n## Installation\n\nInstall the library via [haxelib](https://lib.haxe.org/p/dox):\n```sh\nhaxelib install dox\n```\n\n\n## Usage\n\n\u003e **Note:** Dox requires Haxe 3.1 or higher due to some minor changes in\nabstract rtti xml generation. You'll also need an up-to-date haxelib\n(requires support for `classPath` in _haxelib.json_)\n\n1. Compile the code to be included in the documentation using:\n   ```sh\n   haxe -xml docs/doc.xml -D doc-gen [LIBS] \u003cCLASSPATH\u003e \u003cTARGET\u003e \u003cPACKAGE_NAME\u003e\n   ```\n   E.g.\n   ```sh\n   haxe -xml docs/doc.xml -D doc-gen --lib hxargs --classpath src -java bin my.aweseome.package\n   ```\n2. Generate the HTML pages using:\n   ```sh\n   haxelib run dox -i \u003cINPUT_DIR\u003e\n   ```\n   ...where `input_dir` points to the directory containing the generated .xml file(s) of the previous step, i.e.\n   ```sh\n   haxelib run dox -i docs\n   ```\n\n**:clipboard: For more details, custom theme creation and options [check out the Dox wiki](https://github.com/HaxeFoundation/dox/wiki/)**\n\n\n## Local development\n\nTo test Dox locally, clone the git repo, run `npm install` in root directory. This installs the correct Haxe version using lix and all required dependencies.\n\nAfter that you can run:\n```sh\nnpx haxe --run Make dox xml pages server\n```\nThis compiles Dox, creates XML's, generates the pages and starts a local dev server at \u003chttp://localhost:2000\u003e.\n\n\n## Local development - testing with nektos/act\n\nThe GitHub workflow can be run locally using Nekto's [act](https://github.com/nektos/act) command-line tool. To use it:\n\n1. Install docker\n1. Install [act](https://github.com/nektos/act)\n1. Navigate into the root of your project (where the .github folder is located)\n1. Run the command `act`\n1. On subsequent re-runs you can use `act -r` to reuse previous container which avoids re-installation of components and thus greatly reduces build time.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxefoundation%2Fdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaxefoundation%2Fdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxefoundation%2Fdox/lists"}