{"id":20984730,"url":"https://github.com/prgfx/typedoc-pages-example-16","last_synced_at":"2025-03-13T11:12:58.599Z","repository":{"id":85552452,"uuid":"342532870","full_name":"PRGfx/typedoc-pages-example-16","owner":"PRGfx","description":"minimal example for a problem with [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages)","archived":false,"fork":false,"pushed_at":"2021-02-26T09:57:01.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-20T07:14:36.759Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/PRGfx.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"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}},"created_at":"2021-02-26T09:56:02.000Z","updated_at":"2021-02-26T09:57:03.000Z","dependencies_parsed_at":"2023-03-03T15:15:27.916Z","dependency_job_id":null,"html_url":"https://github.com/PRGfx/typedoc-pages-example-16","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRGfx%2Ftypedoc-pages-example-16","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRGfx%2Ftypedoc-pages-example-16/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRGfx%2Ftypedoc-pages-example-16/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRGfx%2Ftypedoc-pages-example-16/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PRGfx","download_url":"https://codeload.github.com/PRGfx/typedoc-pages-example-16/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243392315,"owners_count":20283563,"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":[],"created_at":"2024-11-19T05:54:21.319Z","updated_at":"2025-03-13T11:12:58.578Z","avatar_url":"https://github.com/PRGfx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"This repository is a minimal example for a problem with [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages).\n\n## Setup\n\n* `npm install`\n* `npm run typedoc-pages`\n\nDocs are built into `./docs-pages`\n\n## Problem\n* docs generated from code are usually grouped in a separate page-group\n* when accessing a sub-module, the page-grouping breaks:\n    * `/docs-pages/modules/two.html`:  \n      ```\n      markdown // example md page in this repo\n        example\n      API\n        Modules\n        one\n        two // current\n      {...module members}\n      ```\n    * `/docs-pages/modules/one.submodule.html`:  \n      ```\n      markdown\n        example\n        Modules // \u003c-- wrongly grouped \u0026 no children*\n      {...module members}\n      ```\n\n\\* submodules removing the rest of the navigation occurs with typedoc only as well.\nHowever there is no grouping of pages so the problem is not apparent.\nRun `npm run typedoc-only` to build docs to `./docs` without pages plugin.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprgfx%2Ftypedoc-pages-example-16","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprgfx%2Ftypedoc-pages-example-16","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprgfx%2Ftypedoc-pages-example-16/lists"}