{"id":27017470,"url":"https://github.com/gjsify/doc","last_synced_at":"2025-04-04T16:23:41.295Z","repository":{"id":57113478,"uuid":"340357542","full_name":"gjsify/doc","owner":"gjsify","description":"Gjs and node-gtk Typescript API documentation generator + typedoc theme + typedoc plugin","archived":false,"fork":false,"pushed_at":"2024-09-17T21:33:34.000Z","size":365145,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-02T21:18:02.049Z","etag":null,"topics":["documentation","gjs","node-gtk","plugin","theme","typedoc","typescript"],"latest_commit_sha":null,"homepage":"https://gjsify.org/pages/api-references","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gjsify.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}},"created_at":"2021-02-19T12:06:58.000Z","updated_at":"2024-11-26T14:45:53.000Z","dependencies_parsed_at":"2022-08-22T04:30:46.070Z","dependency_job_id":"bc98580e-95c1-4296-b011-24a163ac5dc7","html_url":"https://github.com/gjsify/doc","commit_stats":{"total_commits":93,"total_committers":3,"mean_commits":31.0,"dds":"0.032258064516129004","last_synced_commit":"3b4a1bb840f581c1147f0ae0c0de972946712391"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gjsify%2Fdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gjsify%2Fdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gjsify%2Fdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gjsify%2Fdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gjsify","download_url":"https://codeload.github.com/gjsify/doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246946896,"owners_count":20859181,"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","gjs","node-gtk","plugin","theme","typedoc","typescript"],"created_at":"2025-04-04T16:23:40.523Z","updated_at":"2025-04-04T16:23:41.282Z","avatar_url":"https://github.com/gjsify.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doc\nGjs and node-gtk Typescript API documentation\n\n## Submodules\n\nThis repository has submodules, so you need to clone this repository including this submodules:\n\n```bash\ngit clone --recursive https://github.com/gjsify/doc.git\n```\n\nYou can also clone the submodules afterwards:\n\n```bash\ngit clone https://github.com/gjsify/doc.git\ncd doc\ngit submodule update --init --recursive\n```\n\nIf you want to pull updates from this repository you should also pull the submodules:\n\n```bash\ngit pull --recurse-submodules\n```\n\n## Generate documentations\n\nSimply execute:\n\n```bash\nyarn install\nyarn run build\nyarn run start\n```\n\n## TODO\n\nGet images from https://gitlab.gnome.org/GNOME/gtk/-/tree/main/docs/reference/gtk/images\n\n## FAQ\n\nProblem: I get the following error:\n\n```\nFATAL ERROR: Scavenger: semi-space copy Allocation failed - JavaScript heap out of memory\n```\n\nSolution:\n\n```bash\nsudo sysctl -w vm.max_map_count=262144\nNODE_OPTIONS=--max-old-space-size=25600 yarn run start\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgjsify%2Fdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgjsify%2Fdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgjsify%2Fdoc/lists"}