{"id":32460316,"url":"https://github.com/dfinity/typedoc-plugin-icp-docs","last_synced_at":"2026-01-20T17:28:14.888Z","repository":{"id":318946227,"uuid":"1059730323","full_name":"dfinity/typedoc-plugin-icp-docs","owner":"dfinity","description":"Typedoc plugin to assemble docs for js.icp.build","archived":false,"fork":false,"pushed_at":"2025-10-24T08:18:09.000Z","size":41,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-24T09:17:08.470Z","etag":null,"topics":["br-protected-1","icp","markdown","typedoc","typedoc-plugin","typescript"],"latest_commit_sha":null,"homepage":"","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/dfinity.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":".github/CODEOWNERS","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}},"created_at":"2025-09-18T21:27:55.000Z","updated_at":"2025-10-24T08:15:29.000Z","dependencies_parsed_at":"2025-10-17T10:44:44.892Z","dependency_job_id":null,"html_url":"https://github.com/dfinity/typedoc-plugin-icp-docs","commit_stats":null,"previous_names":["dfinity/typedoc-plugin-icp-docs"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/dfinity/typedoc-plugin-icp-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfinity%2Ftypedoc-plugin-icp-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfinity%2Ftypedoc-plugin-icp-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfinity%2Ftypedoc-plugin-icp-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfinity%2Ftypedoc-plugin-icp-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dfinity","download_url":"https://codeload.github.com/dfinity/typedoc-plugin-icp-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfinity%2Ftypedoc-plugin-icp-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281099982,"owners_count":26443537,"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","status":"online","status_checked_at":"2025-10-26T02:00:06.575Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["br-protected-1","icp","markdown","typedoc","typedoc-plugin","typescript"],"created_at":"2025-10-26T11:54:54.381Z","updated_at":"2025-10-26T11:54:56.131Z","avatar_url":"https://github.com/dfinity.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @dfinity/typedoc-plugin-icp-docs\n\n[![NPM Version](https://img.shields.io/npm/v/%40dfinity%2Ftypedoc-plugin-icp-docs)](https://www.npmjs.com/package/@dfinity/typedoc-plugin-icp-docs)\n\nThis is a plugin for [Typedoc](https://typedoc.org/) that prepares Markdown documentation to be published to [js.icp.build](https://js.icp.build).\n\n## Installation\n\n```shell\nnpm install --save-dev @dfinity/typedoc-plugin-icp-docs\n```\n\n\u003e This plugin requires the [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org/) and [typedoc-plugin-frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) plugins, so you need to install them as well.\n\n## Usage\n\nIn your `typedoc.json` file, add the plugin and the output:\n\n```json\n{\n  \"out\": \"src/content/tmp\",\n  \"plugins\": [\n    \"typedoc-plugin-markdown\",\n    \"typedoc-plugin-frontmatter\",\n    \"@dfinity/typedoc-plugin-icp-docs\"\n  ],\n  \"outputs\": [\n    { \"name\": \"markdown\", \"path\": \"src/content/tmp\" },\n    { \"name\": \"icp-docs\", \"path\": \"src/content/docs\" }\n  ]\n}\n```\n\n\u003e This plugin requires the [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org/) and [typedoc-plugin-frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) plugins, so you need to configure them as well.\n\nFor a more concrete setup example, see the [docs](https://github.com/dfinity/pic-js/tree/main/docs/) folder of the [dfinity/pic-js](https://github.com/dfinity/pic-js) repository.\n\n## Development\n\nSee [HACKING.md](./HACKING.md) for more information.\n\n## Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is licensed under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfinity%2Ftypedoc-plugin-icp-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdfinity%2Ftypedoc-plugin-icp-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfinity%2Ftypedoc-plugin-icp-docs/lists"}