{"id":22572294,"url":"https://github.com/normanderwan/unityxrefmaps","last_synced_at":"2025-09-22T18:08:41.788Z","repository":{"id":65816906,"uuid":"336336222","full_name":"NormandErwan/UnityXrefMaps","owner":"NormandErwan","description":"Reference map files to Unity API to use with DocFX","archived":false,"fork":false,"pushed_at":"2024-11-17T05:42:58.000Z","size":81837,"stargazers_count":17,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T23:51:50.708Z","etag":null,"topics":["docfx","unity","unity-documentation","unity3d"],"latest_commit_sha":null,"homepage":"","language":"C#","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/NormandErwan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-02-05T17:05:39.000Z","updated_at":"2025-07-10T21:50:15.000Z","dependencies_parsed_at":"2023-02-19T02:05:13.490Z","dependency_job_id":"b6242a33-8f3c-4847-95f6-29f15105e7ec","html_url":"https://github.com/NormandErwan/UnityXrefMaps","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NormandErwan/UnityXrefMaps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NormandErwan%2FUnityXrefMaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NormandErwan%2FUnityXrefMaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NormandErwan%2FUnityXrefMaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NormandErwan%2FUnityXrefMaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NormandErwan","download_url":"https://codeload.github.com/NormandErwan/UnityXrefMaps/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NormandErwan%2FUnityXrefMaps/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271370313,"owners_count":24747803,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docfx","unity","unity-documentation","unity3d"],"created_at":"2024-12-08T02:08:46.866Z","updated_at":"2025-09-22T18:08:36.736Z","avatar_url":"https://github.com/NormandErwan.png","language":"C#","readme":"# Unity API references for DocFX\n\n\u003e Automatically add clickable links to the Unity API on a DocFX documentation\n\nGenerates references of the Unity API to use with DocFX (the\n[cross reference maps](https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#cross-reference-between-projects)).\nDocFX will set clickable all the references of the Unity API on your documentation.\n\n## Usage\n\n1. Make sure you have setup a DocFX documentation. You can follow the\n   [DocFxForUnity](https://github.com/NormandErwan/DocFxForUnity) instructions otherwise.\n\n2. Add this line to your `docfx.json`:\n\n    - If you want to reference the latest stable version of Unity:\n\n        ```diff\n        \"build\": {\n            \"xref\": [\n        +        \"https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml\"\n            ],\n        }\n        ```\n\n    - If you want to reference a specific version of Unity:\n\n        ```diff\n        \"build\": {\n            \"xref\": [\n        +        \"https://normanderwan.github.io/UnityXrefMaps/\u003cversion\u003e/xrefmap.yml\"\n            ],\n        }\n        ```\n\n      where `\u003cversion\u003e` is a Unity version in the form of `YYYY.x` (*e.g.* 2018.4, 2019.3, 2020.1).\n\n   - If you prefer relying in a offline file:\n\n        ```diff\n        \"build\": {\n            \"xref\": [\n        +        \"UnityXrefMap.yml\"\n            ],\n        }\n        ```\n\n      where `UnityXrefMap.yml` has been downloaded from one of the link above and placed next to your `docfx.json`.\n\n3. Generate your documentation!\n\n## Contribute\n\n- To run this program:\n\n    1. Install Visual Studio 2022.\n    2. Install [.NET 7.0](https://dotnet.microsoft.com/download/dotnet) SDK.\n    3. Clone this repository on your computer.\n    4. Open a terminal on the cloned repository and run:\n\n        ```sh\n        dotnet tool restore\n        dotnet run\n        ```\n\n- For any question or comment, please [open a new issue](https://github.com/NormandErwan/UnityXrefMaps/issues/new).\n\n- If you'd like to contribute, please [fork the repository](https://github.com/NormandErwan/UnityXrefMaps/fork) and use\na feature branch. Pull requests are warmly welcome!\n\n## Disclaimer\n\nThis repository is not sponsored by or affiliated with Unity Technologies or its affiliates.\n“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnormanderwan%2Funityxrefmaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnormanderwan%2Funityxrefmaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnormanderwan%2Funityxrefmaps/lists"}