@8hobbies/typedoc-plugin-plausible
v2.1.0
Published
Add Plausible Analytics tracking code to TypeDoc-generated docs.
Downloads
939
Readme
typedoc-plugin-plausible: Add Plausible Tracking to TypeDoc Generated Docs
This plugin adds a Plausible Analytics tracking code to HTML files generated by TypeDoc.
Install
npm install --save-dev @8hobbies/typedoc-plugin-plausible
Usage
Pass --plugin @8hobbies/typedoc-plugin-plausible
when invoking the typedoc
command:
typedoc --plugin @8hobbies/typedoc-plugin-plausible
Or add the plugin to your typedoc.json file:
// typedoc.json
{
"plugin": ["@8hobbies/typedoc-plugin-plausible"]
}
Configuration
This plugin recognizes a plausibleSiteDomain
option in your typedoc.json
. You can specify the domain
name you use at plausible:
{
"plausibleSiteDomain": "subdomain.example.com"
}
If unspecified, no Plausible Analytics tracking code would be generated.
Additionally, the domain from which the Plausible client script is sourced from can be specified using plausibleSiteOrigin
in your typedoc.json
:
{
"plausibleSiteDomain": "subdomain.example.com",
"plausibleSiteOrigin": "my.domain.com/js"
}
produces
<script defer data-domain="subdomain.example.com" src="https://my.domain.com/js/script.js"></script>
Contributing
Source code is available on GitLab.
To report a bug, visit the issue tracker.
To run test, run npm run test-all
. To display test coverage, run npm run coverage
. To build for
production, run npm pack
. To build the documentation, run npm run doc
.
To send your contribution, open a merge request.
License
Copyright 2024 8 Hobbies, LLC <[email protected]>
Licensed under the Apache License, Version 2.0(the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.