{"id":19418970,"url":"https://github.com/playform/document","last_synced_at":"2026-04-07T09:01:16.329Z","repository":{"id":228269910,"uuid":"773524418","full_name":"PlayForm/Document","owner":"PlayForm","description":"Document 📃","archived":false,"fork":false,"pushed_at":"2026-04-05T03:20:23.000Z","size":1491,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"Current","last_synced_at":"2026-04-05T05:15:07.283Z","etag":null,"topics":["document","documentation","javascript","playform","typedoc","typescript"],"latest_commit_sha":null,"homepage":"https://PlayForm.GitHub.Io/Document","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PlayForm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"custom":"https://buy.stripe.com/3csdQZfzn2LDaBOcMN","open_collective":"playform-cloud-collective"}},"created_at":"2024-03-17T22:09:43.000Z","updated_at":"2026-04-05T03:20:26.000Z","dependencies_parsed_at":"2024-04-01T11:32:05.455Z","dependency_job_id":"56eb2c2d-015c-47eb-ae7c-4104771d4a57","html_url":"https://github.com/PlayForm/Document","commit_stats":{"total_commits":302,"total_committers":7,"mean_commits":"43.142857142857146","dds":0.6688741721854304,"last_synced_commit":"ee33dc4c0be6e11ff733c510a4005a0773df52fa"},"previous_names":["playform/typescriptdocument","playform/document"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/PlayForm/Document","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlayForm%2FDocument","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlayForm%2FDocument/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlayForm%2FDocument/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlayForm%2FDocument/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PlayForm","download_url":"https://codeload.github.com/PlayForm/Document/tar.gz/refs/heads/Current","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlayForm%2FDocument/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31506578,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["document","documentation","javascript","playform","typedoc","typescript"],"created_at":"2024-11-10T13:15:45.023Z","updated_at":"2026-04-07T09:01:16.318Z","avatar_url":"https://github.com/PlayForm.png","language":"TypeScript","readme":"\u003ctable\u003e\u003ctr\u003e \u003ctd colspan=\"1\"\u003e \u003ch3 align=\"center\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://PlayForm.Cloud/Dark/Image/GitHub/TypeScript.svg\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://PlayForm.Cloud/Image/GitHub/TypeScript.svg\"\u003e \u003cimg width=\"28\" alt=\"TypeScript\" src=\"https://PlayForm.Cloud/Image/GitHub/TypeScript.svg\"\u003e \u003c/picture\u003e  \u003c/h3\u003e \u003c/td\u003e \u003ctd colspan=\"3\" valign=\"top\"\u003e \u003ch3 align=\"center\"\u003e Related \u003c/h3\u003e \u003c/td\u003e \u003c/tr\u003e\u003ctr\u003e\u003ctd valign=\"top\" colspan=\"1\"\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Maintain/actions/workflows/Node.yml\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Maintain/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Maintain/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Maintain/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Build\" title=\"Build\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/maintain?activeTab=dependencies\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/librariesio/release/npm/@playform/maintain?logo=dependabot\u0026label=\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/librariesio/release/npm/@playform/maintain?logo=dependabot\u0026label=\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/librariesio/release/npm/@playform/maintain?logo=dependabot\u0026label=\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Dependency\" title=\"Dependency\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/maintain\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/npm/v/@playform/maintain?label=Version\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/npm/v/@playform/maintain?label=Version\u0026logo=npm\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/npm/v/@playform/maintain?label=Version\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Version\" title=\"Version\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003c/td\u003e\u003ctd valign=\"top\" colspan=\"1\"\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Maintain\" target=\"_blank\"\u003e\u003cpicture\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/github/stars/PlayForm/Maintain?style=flat\u0026label=Star\u0026logo=github\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/github/stars/PlayForm/Maintain?style=flat\u0026label=Star\u0026logo=github\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/PlayForm/Maintain?style=flat\u0026label=Star\u0026logo=github\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Star\"\u003e\u003c/picture\u003e\u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/maintain\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/npm/d18m/@playform/maintain?label=Download\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/npm/d18m/@playform/maintain?label=Download\u0026logo=npm\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/npm/d18m/@playform/maintain?label=Download\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Download\" title=\"Download\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Maintain\" target=\"_blank\"\u003e\u003cb\u003e🔧 Maintain —\u003c/b\u003e\u003c/a\u003e\u003c/td\u003e\u003ctd valign=\"top\" colspan=\"1\"\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Format/actions/workflows/Node.yml\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Format/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Format/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/PlayForm/Format/Node.yml?branch=main\u0026label=Build\u0026logo=node.js\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Build\" title=\"Build\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/format?activeTab=dependencies\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/librariesio/release/npm/@playform/format?logo=dependabot\u0026label=\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/librariesio/release/npm/@playform/format?logo=dependabot\u0026label=\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/librariesio/release/npm/@playform/format?logo=dependabot\u0026label=\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Dependency\" title=\"Dependency\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/format\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/npm/v/@playform/format?label=Version\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/npm/v/@playform/format?label=Version\u0026logo=npm\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/npm/v/@playform/format?label=Version\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Version\" title=\"Version\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003c/td\u003e\u003ctd valign=\"top\" colspan=\"1\"\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Format\" target=\"_blank\"\u003e\u003cpicture\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/github/stars/PlayForm/Format?style=flat\u0026label=Star\u0026logo=github\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/github/stars/PlayForm/Format?style=flat\u0026label=Star\u0026logo=github\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/PlayForm/Format?style=flat\u0026label=Star\u0026logo=github\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Star\"\u003e\u003c/picture\u003e\u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://NPMJS.Org/@playform/format\" target=\"_blank\"\u003e \u003cpicture\u003e \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/npm/d18m/@playform/format?label=Download\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\"\u003e \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://img.shields.io/npm/d18m/@playform/format?label=Download\u0026logo=npm\u0026color=white\u0026labelColor=white\u0026logoColor=black\u0026logoWidth=0\"\u003e \u003cimg src=\"https://img.shields.io/npm/d18m/@playform/format?label=Download\u0026logo=npm\u0026color=black\u0026labelColor=black\u0026logoColor=white\u0026logoWidth=0\" alt=\"Download\" title=\"Download\"\u003e \u003c/picture\u003e \u003c/a\u003e\u003cbr\u003e\u003ca href=\"https://GitHub.Com/PlayForm/Format\" target=\"_blank\"\u003e\u003cb\u003e🗻 Format —\u003c/b\u003e\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\u003chr\u003e\n\n# [Document] 📃\n\nThis **[`CLI tool`][Document]** brings TypeDoc documentation generation to your\nTypeScript project.\n\n[`typedoc`][typedoc] 🎁\n\n[`typedoc-plugin-keywords`][typedoc-plugin-keywords] 🎁\n\n[`typedoc-plugin-mdn-links`][typedoc-plugin-mdn-links] 🎁\n\n[`typedoc-plugin-merge-modules`][typedoc-plugin-merge-modules] 🎁\n\n[`typedoc-plugin-remove-references`][typedoc-plugin-remove-references] 🎁\n\n[`typedoc-plugin-rename-defaults`][typedoc-plugin-rename-defaults] 🎁\n\n[`typedoc-plugin-zod`][typedoc-plugin-zod] 🎁\n\n\u003e **Note**\n\u003e\n\u003e `Document` is git-aware — it reads the current branch and remote to generate\n\u003e correct source links in the documentation.\n\n## Installation 🚀\n\nThere are two ways to add `Document` to your project. Let's try the most\nconvenient option first!\n\n### Install as a dev dependency\n\nUsing NPM:\n\n```sh\nnpm install -D -E @playform/document\n```\n\nUsing Yarn:\n\n```sh\nyarn add -D -E @playform/document\n```\n\nUsing PNPM:\n\n```sh\npnpm add -D -E @playform/document\n```\n\n### Run directly\n\nUsing NPM:\n\n```sh\nnpx @playform/document 'Source/**/*.ts'\n```\n\nUsing Yarn:\n\n```sh\nyarn dlx @playform/document 'Source/**/*.ts'\n```\n\nUsing PNPM:\n\n```sh\npnpx @playform/document 'Source/**/*.ts'\n```\n\n## Getting started\n\nAdd a `Document` script to your `package.json`:\n\n**`package.json`**\n\n```json\n{\n\t\"scripts\": {\n\t\t\"Document\": \"Document 'Source/**/*.ts'\"\n\t}\n}\n```\n\nThen run it:\n\n```sh\nnpm run Document\n```\n\nDocumentation is written to `./Documentation` by default.\n\n### Custom output folder\n\nUse `--Folder` to write to a different directory:\n\n```sh\nDocument 'Source/**/*.ts' --Folder docs\n```\n\n**`package.json`**\n\n```json\n{\n\t\"scripts\": {\n\t\t\"Document\": \"Document 'Source/**/*.ts' --Folder docs\"\n\t}\n}\n```\n\n### Multiple entry patterns\n\nPass additional glob patterns as extra arguments:\n\n```sh\nDocument 'Source/**/*.ts' 'Test/**/*.ts'\n```\n\n[Document]: HTTPS://NPMJS.Org/@playform/document\n[typedoc]: HTTPS://NPMJS.Org/typedoc\n[typedoc-plugin-keywords]: HTTPS://NPMJS.Org/typedoc-plugin-keywords\n[typedoc-plugin-mdn-links]: HTTPS://NPMJS.Org/typedoc-plugin-mdn-links\n[typedoc-plugin-merge-modules]: HTTPS://NPMJS.Org/typedoc-plugin-merge-modules\n[typedoc-plugin-remove-references]:\n\tHTTPS://NPMJS.Org/typedoc-plugin-remove-references\n[typedoc-plugin-rename-defaults]:\n\tHTTPS://NPMJS.Org/typedoc-plugin-rename-defaults\n[typedoc-plugin-zod]: HTTPS://NPMJS.Org/typedoc-plugin-zod\n\n## Changelog\n\nSee [`CHANGELOG.md`](CHANGELOG.md) for a history of changes to this tool.\n","funding_links":["https://buy.stripe.com/3csdQZfzn2LDaBOcMN","https://opencollective.com/playform-cloud-collective"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayform%2Fdocument","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplayform%2Fdocument","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayform%2Fdocument/lists"}