{"id":27885853,"url":"https://github.com/thatopen/engine_docs","last_synced_at":"2026-03-02T06:31:07.757Z","repository":{"id":103029511,"uuid":"609207342","full_name":"ThatOpen/engine_docs","owner":"ThatOpen","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-17T10:05:22.000Z","size":60224,"stargazers_count":13,"open_issues_count":3,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-26T19:36:32.408Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs-one-orpin.vercel.app","language":"HTML","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/ThatOpen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"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}},"created_at":"2023-03-03T15:48:04.000Z","updated_at":"2025-07-17T10:05:28.000Z","dependencies_parsed_at":"2024-02-09T01:57:32.677Z","dependency_job_id":"39859e0f-f335-47b5-8747-21d9382709cb","html_url":"https://github.com/ThatOpen/engine_docs","commit_stats":{"total_commits":63,"total_committers":6,"mean_commits":10.5,"dds":"0.38095238095238093","last_synced_commit":"aea7ddd312cffccc5eae6f0a6ae38ba41236d514"},"previous_names":["thatopen/docs","thatopen/engine_docs","ifcjs/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ThatOpen/engine_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatOpen%2Fengine_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatOpen%2Fengine_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatOpen%2Fengine_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatOpen%2Fengine_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThatOpen","download_url":"https://codeload.github.com/ThatOpen/engine_docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatOpen%2Fengine_docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267451242,"owners_count":24089300,"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-07-27T02:00:11.917Z","response_time":82,"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":[],"created_at":"2025-05-05T07:47:57.634Z","updated_at":"2026-03-02T06:31:07.202Z","avatar_url":"https://github.com/ThatOpen.png","language":"HTML","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://thatopen.com/\"\u003eTOC\u003c/a\u003e\n  |\n  \u003ca href=\"https://docs.thatopen.com/intro\"\u003edocumentation\u003c/a\u003e\n  |\n  \u003ca href=\"https://people.thatopen.com/\"\u003ecommunity\u003c/a\u003e\n  |\n  \u003ca href=\"https://www.npmjs.com/package/bim-fragment\"\u003enpm package\u003c/a\u003e\n\u003c/p\u003e\n\n![cover](https://thatopen.github.io/engine_components/resources/cover.png)\n\n# That Open Docs \u003cimg src=\"https://thatopen.github.io/engine_components/resources/favicon.ico\" width=\"32\"/\u003e\n\nThis library contains the official docs for all the libraries of That Open Company.\n\n- It uses [docusaurus](https://docusaurus.io/) to build them.\n- It gathers code from our repos and build the API docs using [TypeDoc](https://typedoc.org/).\n- It gathers the HTML examples from our repos and build the tutorials.\n\nIf you see anything outdated in the [docs page](https://docs.thatopen.com/intro), feel free to open an issue. If the issue is specific to a specific repository, please open the issue in that repository!\n\nIf you have any questions, you can also ask around in our [community](https://people.thatopen.com/).\n\n\n## 🤝 Want our help?\nAre you developing a project with our technology and would like our help?\nApply now to join [That Open Accelerator Program](https://thatopen.com/accelerator)!\n\n\n## Local development\n\n### BEFORE YOU START\n\nThis repository just has the general articles and the code to bring all the docs together and present it in a nice way.\n\nThe API documentation and tutorials for each library are not written in this repository, but in each library. That way, we can:\n\n- Make the API docs in TypeDoc, making them available in Intellisense on all IDEs.\n- Check that the tutorials keep working when we make changes / fixes / new features to the libraries.\n\nFor example, imagine you are looking for the `Worlds` API documentation or tutorial. You won't find them here. It's in the `components` repository (as the `Worlds` class belongs to that repo). You can find them [here](https://github.com/ThatOpen/engine_components/blob/main/packages/core/src/core/Worlds/index.ts) and [here](https://github.com/ThatOpen/engine_components/blob/main/packages/core/src/core/Worlds/example.ts) respectively.\n\nThis means that if you want to raise an issue or fix a typo from the API or the tutorials, this is not the place to do so. \n\n\u003e If you are not sure the repository where the issue belongs, feel free to create the issue here and we'll redirect it to the right repo. 👌🏻\n\nThat said, maybe you want to execute our docs locally. We'll teach you how to do that in the following steps.\n\n### Clone the libraries locally\n\nThe docs are build centrally to have everything in the same place. This means that the docs require the libraries to be **present at the same directory**. You can achieve that by running the following commands:\n\n```bash\ngit clone https://github.com/ThatOpen/engine_docs/\ngit clone https://github.com/ThatOpen/engine_components/\ngit clone https://github.com/ThatOpen/engine_fragment/\ngit clone https://github.com/ThatOpen/engine_ui-components/\n```\n\n### Install all dependencies\n\nYou can do it with the following command:\n\n```bash\nyarn install\n```\n\n### Setting up the docs\n\nTo generate the docs locally, you can run the following command. This will copy the libraries automatically and set everything up so that you can execute and build the docs.\n\n```bash\nyarn docs:local\n```\n\n### Running this locally\n\nNow you can run the docs locally using the following command:\n\n```bash\nyarn start\n```\n\n### Building the docs\n\nFinally, to build the docs, you can execute the following command:\n\n```bash\nyarn build:local\n```\n\nIf you have previously executed `yarn docs:local`, you can also just execute the following:\n\n```bash\nyarn build\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatopen%2Fengine_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthatopen%2Fengine_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatopen%2Fengine_docs/lists"}