{"id":13406385,"url":"https://github.com/TypeStrong/typedoc","last_synced_at":"2025-03-14T10:33:12.431Z","repository":{"id":17359935,"uuid":"20131603","full_name":"TypeStrong/typedoc","owner":"TypeStrong","description":"Documentation generator for TypeScript projects.","archived":false,"fork":false,"pushed_at":"2024-04-29T11:49:38.000Z","size":14222,"stargazers_count":7371,"open_issues_count":40,"forks_count":669,"subscribers_count":72,"default_branch":"master","last_synced_at":"2024-05-02T00:56:17.972Z","etag":null,"topics":["documentation","generator","typescript"],"latest_commit_sha":null,"homepage":"https://typedoc.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TypeStrong.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-24T14:40:16.000Z","updated_at":"2024-05-03T01:24:45.109Z","dependencies_parsed_at":"2023-09-25T01:36:12.796Z","dependency_job_id":"ff50f620-068d-4285-b879-5e646be28977","html_url":"https://github.com/TypeStrong/typedoc","commit_stats":null,"previous_names":[],"tags_count":205,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypeStrong","download_url":"https://codeload.github.com/TypeStrong/typedoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221458385,"owners_count":16825302,"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","generator","typescript"],"created_at":"2024-07-30T19:02:28.861Z","updated_at":"2025-03-14T10:33:12.418Z","avatar_url":"https://github.com/TypeStrong.png","language":"TypeScript","readme":"# TypeDoc\n\nDocumentation generator for TypeScript projects.\n\n## Documentation\n\nFor more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.\n\n## Installation\n\nTypeDoc runs on Node.js and is available as a NPM package.\n\n```text\nnpm install typedoc --save-dev\n```\n\n## Usage\n\nTo generate documentation TypeDoc needs to know your project entry point and TypeScript\ncompiler options. It will automatically try to find your `tsconfig.json` file, so you can\njust specify the entry point of your library:\n\n```text\ntypedoc src/index.ts\n```\n\nIf you have multiple entry points, specify each of them.\n\n```text\ntypedoc package1/index.ts package2/index.ts\n```\n\nIf you specify a directory, TypeDoc will use the `entryPointStrategy` option to determine how to resolve it.\nBy default, TypeDoc will search for a file called `index` under the directory.\n\n### Monorepos / Workspaces\n\nIf your codebase is comprised of one or more npm packages, you can build documentation for each of them individually\nand merge the results together into a single site by setting `entryPointStrategy` to `packages`. In this mode TypeDoc\nrequires configuration to be present in each directory to specify the entry points. For an example setup, see\nhttps://github.com/Gerrit0/typedoc-packages-example\n\n### Arguments\n\nFor a complete list of the command line arguments run `typedoc --help` or visit\n[our website](https://typedoc.org/options/).\n\n-   `--out \u003cpath/to/documentation/\u003e`\u003cbr\u003e\n    Specifies the location the documentation should be written to. Defaults to `./docs`\n-   `--json \u003cpath/to/output.json\u003e`\u003cbr\u003e\n    Specifies the location and file name a json file describing the project is\n    written to. When specified no documentation will be generated unless `--out` is also\n    specified.\n-   `--options`\u003cbr\u003e\n    Specify a json option file that should be loaded. If not specified TypeDoc\n    will look for 'typedoc.json' in the current directory.\n-   `--tsconfig \u003cpath/to/tsconfig.json\u003e`\u003cbr\u003e\n    Specify a typescript config file that should be loaded. If not\n    specified TypeDoc will look for 'tsconfig.json' in the current directory.\n-   `--exclude \u003cpattern\u003e`\u003cbr\u003e\n    Exclude files by the given pattern when a path is provided as source.\n    Supports standard minimatch patterns.\n\n#### Theming\n\n-   `--theme \u003cdefault|plugin defined theme\u003e`\u003cbr\u003e\n    Specify the theme that should be used.\n-   `--name \u003cDocumentation title\u003e`\u003cbr\u003e\n    Set the name of the project that will be used in the header of the template.\n-   `--readme \u003cpath/to/readme|none\u003e`\u003cbr\u003e\n    Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page\n    and start the documentation on the globals page.\n\n#### Miscellaneous\n\n-   `--version`\u003cbr\u003e\n    Display the version number of TypeDoc.\n-   `--help`\u003cbr\u003e\n    Display all TypeDoc options.\n\n## Contributing\n\nThis project is maintained by a community of developers. Contributions are welcome and appreciated.\nYou can find TypeDoc on GitHub; feel free to open an issue or create a pull request:\nhttps://github.com/TypeStrong/typedoc\n\nFor more information, read the [contribution guide](https://github.com/TypeStrong/typedoc/blob/master/.github/CONTRIBUTING.md).\n","funding_links":[],"categories":["TypeScript","typescript","Table of Contents","Generators","JavaScript","documentation","TypeScript 工具/库/框架","HTML","\u003ca name=\"TypeScript\"\u003e\u003c/a\u003eTypeScript"],"sub_categories":["TypeScript","文档生成"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypeStrong%2Ftypedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTypeStrong%2Ftypedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypeStrong%2Ftypedoc/lists"}