{"id":21546278,"url":"https://github.com/8hobbies/typedoc-plugin-plausible","last_synced_at":"2025-10-30T23:23:26.526Z","repository":{"id":231800081,"uuid":"779166523","full_name":"8hobbies/typedoc-plugin-plausible","owner":"8hobbies","description":"A TypeDoc plugin that adds a Plausible Analytics tracking code to HTML files generated by TypeDoc. Mirror of https://gitlab.com/8hobbies/typedoc-plugin-plausible","archived":false,"fork":false,"pushed_at":"2024-04-13T08:01:39.000Z","size":219,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-13T21:57:02.128Z","etag":null,"topics":["typedoc","typedoc-plugin"],"latest_commit_sha":null,"homepage":"https://typedoc-plausible.8hob.io","language":"TypeScript","has_issues":false,"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/8hobbies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-03-29T07:30:25.000Z","updated_at":"2024-04-15T02:41:22.684Z","dependencies_parsed_at":"2024-04-15T02:41:10.617Z","dependency_job_id":null,"html_url":"https://github.com/8hobbies/typedoc-plugin-plausible","commit_stats":null,"previous_names":["8hobbies/typedoc-plugin-plausible"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8hobbies%2Ftypedoc-plugin-plausible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8hobbies%2Ftypedoc-plugin-plausible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8hobbies%2Ftypedoc-plugin-plausible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/8hobbies%2Ftypedoc-plugin-plausible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/8hobbies","download_url":"https://codeload.github.com/8hobbies/typedoc-plugin-plausible/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244135905,"owners_count":20403797,"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":["typedoc","typedoc-plugin"],"created_at":"2024-11-24T06:09:35.697Z","updated_at":"2025-10-30T23:23:21.492Z","avatar_url":"https://github.com/8hobbies.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-plugin-plausible: Add Plausible Tracking to TypeDoc Generated Docs\n\n[![npm version](https://badge.fury.io/js/@8hobbies%2Ftypedoc-plugin-plausible.svg)](https://badge.fury.io/js/@8hobbies%2Ftypedoc-plugin-plausible)\n[![pipeline status](https://gitlab.com/8hobbies/typedoc-plugin-plausible/badges/master/pipeline.svg)](https://gitlab.com/8hobbies/typedoc-plugin-plausible/-/commits/master)\n\n[GitLab](https://gitlab.com/8hobbies/typedoc-plugin-plausible) | [GitHub](https://github.com/8hobbies/typedoc-plugin-plausible)\n\nThis plugin adds a [Plausible Analytics][] tracking code to HTML files generated by [TypeDoc][].\n\n## Install\n\n```\nnpm install --save-dev @8hobbies/typedoc-plugin-plausible\n```\n\n## Usage\n\nPass `--plugin @8hobbies/typedoc-plugin-plausible` when invoking the `typedoc` command:\n\n```\ntypedoc --plugin @8hobbies/typedoc-plugin-plausible\n```\n\nOr add the plugin to your typedoc.json file:\n\n```\n// typedoc.json\n{\n  \"plugin\": [\"@8hobbies/typedoc-plugin-plausible\"]\n}\n```\n\n## Configuration\n\nThis plugin recognizes a `plausibleSiteDomain` option in your `typedoc.json`. You can specify the domain\nname you use at plausible:\n\n```json\n{\n  \"plausibleSiteDomain\": \"subdomain.example.com\"\n}\n```\n\nIf unspecified, no Plausible Analytics tracking code would be generated.\n\nAdditionally, the domain from which the Plausible client script is sourced from can be specified using `plausibleSiteOrigin` in your `typedoc.json`:\n\n```json\n{\n  \"plausibleSiteDomain\": \"subdomain.example.com\",\n  \"plausibleSiteOrigin\": \"my.domain.com/js\"\n}\n```\n\nproduces\n\n```html\n\u003cscript defer data-domain=\"subdomain.example.com\" src=\"https://my.domain.com/js/script.js\"\u003e\u003c/script\u003e\n```\n\n## Contributing\n\nSource code is available on [GitLab][].\n\nTo report a bug, visit the [issue tracker][].\n\nTo run test, run `npm run test-all`. To display test coverage, run `npm run coverage`. To build for\nproduction, run `npm pack`. To build the documentation, run `npm run doc`.\n\nTo send your contribution, open a [merge request][].\n\n## License\n\n```text\nCopyright 2024 8 Hobbies, LLC \u003chong@8hobbies.com\u003e\n\nLicensed under the Apache License, Version 2.0(the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n[GitHub Pages]: https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-custom-plausible-page-for-your-github-pages-site\n[GitLab Pages]: https://docs.gitlab.com/ee/user/project/pages/introduction.html#custom-error-codes-pages\n[GitLab]: https://gitlab.com/8hobbies/typedoc-plugin-plausible\n[Plausible Analytics]: https://plausible.io/\n[issue tracker]: https://gitlab.com/8hobbies/typedoc-plugin-plausible/issues\n[merge request]: https://gitlab.com/8hobbies/typedoc-plugin-plausible/-/merge_requests\n[TypeDoc]: https://typedoc.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8hobbies%2Ftypedoc-plugin-plausible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F8hobbies%2Ftypedoc-plugin-plausible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F8hobbies%2Ftypedoc-plugin-plausible/lists"}