{"id":16329049,"url":"https://github.com/ts-docs/ts-docs","last_synced_at":"2025-10-25T21:30:59.725Z","repository":{"id":39850185,"uuid":"391151108","full_name":"ts-docs/ts-docs","owner":"ts-docs","description":"A documentation generator for typescript. Generate beautiful and informative documentation with zero setup!","archived":false,"fork":false,"pushed_at":"2024-07-20T16:57:12.000Z","size":3825,"stargazers_count":74,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-12T21:47:21.671Z","etag":null,"topics":["docs","documentation","generator","typescript","typescript-docs"],"latest_commit_sha":null,"homepage":"https://ts-docs.github.io/ts-docs/","language":"TypeScript","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/ts-docs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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-07-30T17:53:41.000Z","updated_at":"2024-10-25T02:43:48.000Z","dependencies_parsed_at":"2022-09-12T19:03:57.666Z","dependency_job_id":"2b152da0-ef00-431e-9f7b-9900fb125e19","html_url":"https://github.com/ts-docs/ts-docs","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ts-docs%2Fts-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ts-docs%2Fts-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ts-docs%2Fts-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ts-docs%2Fts-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ts-docs","download_url":"https://codeload.github.com/ts-docs/ts-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238212367,"owners_count":19434950,"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":["docs","documentation","generator","typescript","typescript-docs"],"created_at":"2024-10-10T23:14:39.920Z","updated_at":"2025-10-25T21:30:54.342Z","avatar_url":"https://github.com/ts-docs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/ts-docs/ts-docs/blob/main/assets/logo.png?raw=true\" width=\"200px\" /\u003e\n\u003c/p\u003e\n\n# ts-docs\n\n[![GitHub license](https://img.shields.io/github/license/ts-docs/ts-docs?style=flat-square)](https://github.com/ts-docs/ts-docs/blob/main/LICENSE)\n[![GitHub stars](https://img.shields.io/github/stars/ts-docs/ts-docs?style=flat-square)](https://github.com/ts-docs/ts-docs/stargazers)\n[![GitHub issues](https://img.shields.io/github/issues/ts-docs/ts-docs?style=flat-square)](https://github.com/ts-docs/ts-docs/issues)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/639fba225a094e769b4c8976a30bf7c1)](https://www.codacy.com/gh/ts-docs/ts-docs/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=ts-docs/ts-docs\u0026amp;utm_campaign=Badge_Grade)\n\nAn opinionated documentation generator for typescript - generate informative and accurate documentation sites with zero setup.\n\nIf you want to check out how a typical ts-docs documentation looks like, head over to the official docs, found [here](https://ts-docs.github.io/ts-docs/index.html).\n\n## Installation\n\n**Important:** You need typescript 4.3+ in order to use ts-docs!\n\n```\nnpm i --save-dev @ts-docs/ts-docs @ts-docs/default-docs-structure \n```\n\n## Usage \n\nIn order for ts-docs to generate proper documentation, you need to give it one or multiple \"project entry points\". **Every entry point should point to a different project**. You can find out more information about all the options ts-docs has [here](https://ts-docs.github.io/ts-docs/pages/Guides/Options.html).\n\nSimple usage which uses the default options:\n```\nts-docs src/index.ts\n```\n\n## Features\n\n- Documentation structure akin to [docs-rs](https://docs.rs/) and rust in general, every folder inside the project is a different module. \n- Document multiple projects, monorepo support out of the box.\n- Slick design, dark/light theme, powerful search and filter function.\n- Link external references to their respective documentation.\n- Out of the box documentation generation for different branches of your repository.\n- Changelog generation, pulled from github releases.\n- Built-in custom pages support. Host your guides and tutorials right inside the documentation.\n- 100% accurate, you won't find missing references unless they're external.\n- Unit tests inside documentation comments.\n\n## Examples\n\n\u003cdetails\u003e\n\u003csummary\u003ets-docs\u003c/summary\u003e\n\u003cimg src=\"https://i.imgur.com/8FpQb1F.png\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003edetritus\u003c/summary\u003e\n\u003cimg src=\"https://i.imgur.com/yBtBsg4.png\"\u003e\n\u003c/details\u003e\n\n\n## Contributing\n\nContributions are appreciated, feel free to open an issue or a pull request [here](https://github.com/ts-docs/ts-docs).\n\nMake sure to read the [contribution guide](https://github.com/ts-docs/ts-docs/blob/main/.github/CONTRIBUTING.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fts-docs%2Fts-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fts-docs%2Fts-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fts-docs%2Fts-docs/lists"}